Package com.vmware.nsx_policy.infra.napp.common_agent

Interface HostConfig

All Superinterfaces:

HostConfigTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

HostConfigStub

public interface HostConfig
extends com.vmware.vapi.bindings.Service, HostConfigTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.napp.common_agent.HostConfigTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method	Description
CommonAgentHostConfigurationInfo	get()	Get the current NSX Application Platform Common Agent host configuration.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback)	Get the current NSX Application Platform Common Agent host configuration.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get the current NSX Application Platform Common Agent host configuration.
CommonAgentHostConfigurationInfo	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Get the current NSX Application Platform Common Agent host configuration.
CommonAgentHostConfigurationInfo	patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo)	Patch the current NSX Application Platform Common Agent host configuration.
void	patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo, com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback)	Patch the current NSX Application Platform Common Agent host configuration.
void	patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo, com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Patch the current NSX Application Platform Common Agent host configuration.
CommonAgentHostConfigurationInfo	patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Patch the current NSX Application Platform Common Agent host configuration.
CommonAgentHostConfigurationInfo	reset()	Reset NSX Application Platform Common Agent host configuration to the default setting.
void	reset(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback)	Reset NSX Application Platform Common Agent host configuration to the default setting.
void	reset(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Reset NSX Application Platform Common Agent host configuration to the default setting.
CommonAgentHostConfigurationInfo	reset(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)	Reset NSX Application Platform Common Agent host configuration to the default setting.

Method Detail

get

CommonAgentHostConfigurationInfo get()

Get the current NSX Application Platform Common Agent host configuration. Recommend to keep the value same for flow_data_collection_interval and context_data_collection_interval.

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

Returns:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

CommonAgentHostConfigurationInfo get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the current NSX Application Platform Common Agent host configuration. Recommend to keep the value same for flow_data_collection_interval and context_data_collection_interval.

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:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

Get the current NSX Application Platform Common Agent host configuration. Recommend to keep the value same for flow_data_collection_interval and context_data_collection_interval.

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

Invocation Result:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

get

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

Get the current NSX Application Platform Common Agent host configuration. Recommend to keep the value same for flow_data_collection_interval and context_data_collection_interval.

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:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

invocationConfig - Configuration for the method invocation.

patch

CommonAgentHostConfigurationInfo patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo)

Patch the current NSX Application Platform Common Agent host configuration. Return error if NSX Application Platform Common Agent is not registered with NSX. \"private_ip_range\" is the only field allowed to patch.

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

Parameters:

commonAgentHostConfigurationInfo - (required)

Returns:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

patch

CommonAgentHostConfigurationInfo patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Patch the current NSX Application Platform Common Agent host configuration. Return error if NSX Application Platform Common Agent is not registered with NSX. \"private_ip_range\" is the only field allowed to patch.

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:

commonAgentHostConfigurationInfo - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

patch

void patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo,
           com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback)

Patch the current NSX Application Platform Common Agent host configuration. Return error if NSX Application Platform Common Agent is not registered with NSX. \"private_ip_range\" is the only field allowed to patch.

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

Invocation Result:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

commonAgentHostConfigurationInfo - (required)

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

patch

void patch(CommonAgentHostConfigurationInfo commonAgentHostConfigurationInfo,
           com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Patch the current NSX Application Platform Common Agent host configuration. Return error if NSX Application Platform Common Agent is not registered with NSX. \"private_ip_range\" is the only field allowed to patch.

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:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

commonAgentHostConfigurationInfo - (required)

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

invocationConfig - Configuration for the method invocation.

reset

CommonAgentHostConfigurationInfo reset()

Reset NSX Application Platform Common Agent host configuration to the default setting. Clear NSX Application Platform Common Agent host configuration if NSX Application Platform Common Agent is not registered with NSX. Return the NSX Application Platform Common Agent host configuration after reset operation.

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

Returns:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

reset

CommonAgentHostConfigurationInfo reset(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Reset NSX Application Platform Common Agent host configuration to the default setting. Clear NSX Application Platform Common Agent host configuration if NSX Application Platform Common Agent is not registered with NSX. Return the NSX Application Platform Common Agent host configuration after reset operation.

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:

com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

reset

void reset(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback)

Reset NSX Application Platform Common Agent host configuration to the default setting. Clear NSX Application Platform Common Agent host configuration if NSX Application Platform Common Agent is not registered with NSX. Return the NSX Application Platform Common Agent host configuration after reset operation.

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

Invocation Result:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

reset

void reset(com.vmware.vapi.bindings.client.AsyncCallback<CommonAgentHostConfigurationInfo> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Reset NSX Application Platform Common Agent host configuration to the default setting. Clear NSX Application Platform Common Agent host configuration if NSX Application Platform Common Agent is not registered with NSX. Return the NSX Application Platform Common Agent host configuration after reset operation.

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:
com.vmware.nsx_policy.model.CommonAgentHostConfigurationInfo

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

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

invocationConfig - Configuration for the method invocation.