com.vmware.nsx_policy.infra

Interface HostTransportNodeProfiles

All Superinterfaces:

HostTransportNodeProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

HostTransportNodeProfilesStub

public interface HostTransportNodeProfiles
extends com.vmware.vapi.bindings.Service, HostTransportNodeProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.HostTransportNodeProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String transportNodeProfileId) Deletes the specified host transport node profile.
void	delete(java.lang.String transportNodeProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified host transport node profile.
void	delete(java.lang.String transportNodeProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified host transport node profile.
void	delete(java.lang.String transportNodeProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes the specified host transport node profile.
PolicyHostTransportNodeProfile	get(java.lang.String hostTransportNodeProfileId) Returns information about a specified host transport node profile.
void	get(java.lang.String hostTransportNodeProfileId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback) Returns information about a specified host transport node profile.
void	get(java.lang.String hostTransportNodeProfileId, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified host transport node profile.
PolicyHostTransportNodeProfile	get(java.lang.String hostTransportNodeProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified host transport node profile.
PolicyHostTransportNodeProfileListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Returns information about all host transport node profiles.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfileListResult> asyncCallback) Returns information about all host transport node profiles.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all host transport node profiles.
PolicyHostTransportNodeProfileListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about all host transport node profiles.
PolicyHostTransportNodeProfile	update(java.lang.String transportNodeProfileId, PolicyHostTransportNodeProfile policyHostTransportNodeProfile, java.lang.Boolean overrideNsxOwnership) Host transport node profile captures the configuration needed to create a host transport node.
void	update(java.lang.String transportNodeProfileId, PolicyHostTransportNodeProfile policyHostTransportNodeProfile, java.lang.Boolean overrideNsxOwnership, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback) Host transport node profile captures the configuration needed to create a host transport node.
void	update(java.lang.String transportNodeProfileId, PolicyHostTransportNodeProfile policyHostTransportNodeProfile, java.lang.Boolean overrideNsxOwnership, com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Host transport node profile captures the configuration needed to create a host transport node.
PolicyHostTransportNodeProfile	update(java.lang.String transportNodeProfileId, PolicyHostTransportNodeProfile policyHostTransportNodeProfile, java.lang.Boolean overrideNsxOwnership, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Host transport node profile captures the configuration needed to create a host transport node.

Method Detail

delete

void delete(java.lang.String transportNodeProfileId)

Deletes the specified host transport node profile. A host transport node profile can be deleted only when it is not attached to any compute collection.

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

Parameters:

transportNodeProfileId - (required)

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

delete

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

Deletes the specified host transport node profile. A host transport node profile can be deleted only when it is not attached to any compute collection.

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:

transportNodeProfileId - (required)

invocationConfig - Configuration for the method invocation.

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

delete

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

Deletes the specified host transport node profile. A host transport node profile can be deleted only when it is not attached to any compute collection.

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

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

Parameters:

transportNodeProfileId - (required)

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

delete

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

Deletes the specified host transport node profile. A host transport node profile can be deleted only when it is not attached to any compute collection.

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:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Parameters:

transportNodeProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

PolicyHostTransportNodeProfile get(java.lang.String hostTransportNodeProfileId)

Returns information about a specified host transport node profile.

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

Parameters:

hostTransportNodeProfileId - (required)

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfile

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

PolicyHostTransportNodeProfile get(java.lang.String hostTransportNodeProfileId,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about a specified host transport node profile.

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:

hostTransportNodeProfileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfile

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(java.lang.String hostTransportNodeProfileId,
         com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback)

Returns information about a specified host transport node profile.

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

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

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

Parameters:

hostTransportNodeProfileId - (required)

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

get

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

Returns information about a specified host transport node profile.

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

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

Parameters:

hostTransportNodeProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

PolicyHostTransportNodeProfileListResult list(java.lang.String cursor,
                                              java.lang.String includedFields,
                                              java.lang.Long pageSize,
                                              java.lang.Boolean sortAscending,
                                              java.lang.String sortBy)

Returns information about all host transport node profiles.

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfileListResult

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

list

PolicyHostTransportNodeProfileListResult list(java.lang.String cursor,
                                              java.lang.String includedFields,
                                              java.lang.Long pageSize,
                                              java.lang.Boolean sortAscending,
                                              java.lang.String sortBy,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all host transport node profiles.

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:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfileListResult

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

list

void list(java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfileListResult> asyncCallback)

Returns information about all host transport node profiles.

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

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

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

void list(java.lang.String cursor,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfileListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about all host transport node profiles.

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

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.

update

PolicyHostTransportNodeProfile update(java.lang.String transportNodeProfileId,
                                      PolicyHostTransportNodeProfile policyHostTransportNodeProfile,
                                      java.lang.Boolean overrideNsxOwnership)

Host transport node profile captures the configuration needed to create a host transport node. A host transport node profile can be attached to compute collections for automatic host transport node creation of member hosts. When configurations of a host transport node profile(TNP) are updated, all the host transport nodes in all the compute collections to which this TNP is attached are updated to reflect the updated configuration.

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

Parameters:

transportNodeProfileId - (required)

policyHostTransportNodeProfile - (required)

overrideNsxOwnership - Override NSX Ownership (optional, default to false)

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfile

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

update

PolicyHostTransportNodeProfile update(java.lang.String transportNodeProfileId,
                                      PolicyHostTransportNodeProfile policyHostTransportNodeProfile,
                                      java.lang.Boolean overrideNsxOwnership,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Host transport node profile captures the configuration needed to create a host transport node. A host transport node profile can be attached to compute collections for automatic host transport node creation of member hosts. When configurations of a host transport node profile(TNP) are updated, all the host transport nodes in all the compute collections to which this TNP is attached are updated to reflect the updated configuration.

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:

transportNodeProfileId - (required)

policyHostTransportNodeProfile - (required)

overrideNsxOwnership - Override NSX Ownership (optional, default to false)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyHostTransportNodeProfile

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

update

void update(java.lang.String transportNodeProfileId,
            PolicyHostTransportNodeProfile policyHostTransportNodeProfile,
            java.lang.Boolean overrideNsxOwnership,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback)

Host transport node profile captures the configuration needed to create a host transport node. A host transport node profile can be attached to compute collections for automatic host transport node creation of member hosts. When configurations of a host transport node profile(TNP) are updated, all the host transport nodes in all the compute collections to which this TNP is attached are updated to reflect the updated configuration.

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

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

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

Parameters:

transportNodeProfileId - (required)

policyHostTransportNodeProfile - (required)

overrideNsxOwnership - Override NSX Ownership (optional, default to false)

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

update

void update(java.lang.String transportNodeProfileId,
            PolicyHostTransportNodeProfile policyHostTransportNodeProfile,
            java.lang.Boolean overrideNsxOwnership,
            com.vmware.vapi.bindings.client.AsyncCallback<PolicyHostTransportNodeProfile> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Host transport node profile captures the configuration needed to create a host transport node. A host transport node profile can be attached to compute collections for automatic host transport node creation of member hosts. When configurations of a host transport node profile(TNP) are updated, all the host transport nodes in all the compute collections to which this TNP is attached are updated to reflect the updated configuration.

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

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

Parameters:

transportNodeProfileId - (required)

policyHostTransportNodeProfile - (required)

overrideNsxOwnership - Override NSX Ownership (optional, default to false)

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

invocationConfig - Configuration for the method invocation.