com.vmware.nsx.dhcp

Interface ServerProfiles

All Superinterfaces:

ServerProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ServerProfilesStub

public interface ServerProfiles
extends com.vmware.vapi.bindings.Service, ServerProfilesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.dhcp.ServerProfilesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
DhcpProfile	create(DhcpProfile dhcpProfile) Deprecated.
void	create(DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback) Deprecated.
void	create(DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	create(DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String profileId) Deprecated.
void	delete(java.lang.String profileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String profileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String profileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	get(java.lang.String profileId) Deprecated.
void	get(java.lang.String profileId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback) Deprecated.
void	get(java.lang.String profileId, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	get(java.lang.String profileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfileListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) Deprecated.
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<DhcpProfileListResult> asyncCallback) Deprecated.
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<DhcpProfileListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfileListResult	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) Deprecated.
DhcpProfile	reallocate(java.lang.String serverProfileId, DhcpProfile dhcpProfile) Deprecated.
void	reallocate(java.lang.String serverProfileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback) Deprecated.
void	reallocate(java.lang.String serverProfileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	reallocate(java.lang.String serverProfileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	update(java.lang.String profileId, DhcpProfile dhcpProfile) Deprecated.
void	update(java.lang.String profileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback) Deprecated.
void	update(java.lang.String profileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
DhcpProfile	update(java.lang.String profileId, DhcpProfile dhcpProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
DhcpProfile create(DhcpProfile dhcpProfile)

Deprecated.

Create a DHCP server profile. If no edge member is specified, edge members to run the dhcp servers will be auto-allocated from the edge cluster.

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

Parameters:

dhcpProfile - (required)

Returns:

com.vmware.nsx.model.DhcpProfile

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

create

@Deprecated
DhcpProfile create(DhcpProfile dhcpProfile,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create a DHCP server profile. If no edge member is specified, edge members to run the dhcp servers will be auto-allocated from the edge cluster.

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:

dhcpProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpProfile

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

create

@Deprecated
void create(DhcpProfile dhcpProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback)

Deprecated.

Create a DHCP server profile. If no edge member is specified, edge members to run the dhcp servers will be auto-allocated from the edge cluster.

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

Invocation Result:
com.vmware.nsx.model.DhcpProfile

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

Parameters:

dhcpProfile - (required)

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

create

@Deprecated
void create(DhcpProfile dhcpProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Create a DHCP server profile. If no edge member is specified, edge members to run the dhcp servers will be auto-allocated from the edge cluster.

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

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

Parameters:

dhcpProfile - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String profileId)

Deprecated.

Delete a DHCP server profile specified by the profile id.

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

Parameters:

profileId - (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

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

Deprecated.

Delete a DHCP server profile specified by the profile id.

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:

profileId - (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

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

Deprecated.

Delete a DHCP server profile specified by the profile id.

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:

profileId - (required)

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

delete

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

Deprecated.

Delete a DHCP server profile specified by the profile id.

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:

profileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
DhcpProfile get(java.lang.String profileId)

Deprecated.

Return the DHCP profile specified by the profile id.

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

Parameters:

profileId - (required)

Returns:

com.vmware.nsx.model.DhcpProfile

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

@Deprecated
DhcpProfile get(java.lang.String profileId,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return the DHCP profile specified by the profile id.

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:

profileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpProfile

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

@Deprecated
void get(java.lang.String profileId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback)

Deprecated.

Return the DHCP profile specified by the profile id.

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

Invocation Result:
com.vmware.nsx.model.DhcpProfile

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

Parameters:

profileId - (required)

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

get

@Deprecated
void get(java.lang.String profileId,
                     com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return the DHCP profile specified by the profile id.

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

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

Parameters:

profileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
DhcpProfileListResult list(java.lang.String cursor,
                                       java.lang.String includedFields,
                                       java.lang.Long pageSize,
                                       java.lang.Boolean sortAscending,
                                       java.lang.String sortBy)

Deprecated.

Get a paginated list of DHCP server 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.model.DhcpProfileListResult

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

@Deprecated
DhcpProfileListResult 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)

Deprecated.

Get a paginated list of DHCP server 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.model.DhcpProfileListResult

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

@Deprecated
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<DhcpProfileListResult> asyncCallback)

Deprecated.

Get a paginated list of DHCP server profiles.

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

Invocation Result:
com.vmware.nsx.model.DhcpProfileListResult

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

@Deprecated
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<DhcpProfileListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Get a paginated list of DHCP server 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.model.DhcpProfileListResult

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.

reallocate

@Deprecated
DhcpProfile reallocate(java.lang.String serverProfileId,
                                   DhcpProfile dhcpProfile)

Deprecated.

As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the edge-cluster-member-indexes fields will be picked up by this re-allication API. The othere fields in the payload will be ignored. If the edge-cluster-id in the payload DhcpProfile is different from the current edge-cluster-id of the profile, the referencing DHCP server(s) will be re-allocated to the new edge cluster. If the edge-cluster-id is not changed, the referencing DHCP server(s) will be re-allocated to the given edge members in the edge cluster. In this case, this REST API will act same as that of updating a DhcpProfile. If the edge cluster member indexes are provided, they should exist in the given edge cluster. If the indexes are not specified in the DhcpProfile, edge members will be auto-allocated from the given edge cluster. Please note that re-allocating edge-cluster will cause lose of all exisitng DHCP lease information. This API is used only when loosing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.

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

Parameters:

serverProfileId - (required)

dhcpProfile - (required)

Returns:

com.vmware.nsx.model.DhcpProfile

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

reallocate

@Deprecated
DhcpProfile reallocate(java.lang.String serverProfileId,
                                   DhcpProfile dhcpProfile,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the edge-cluster-member-indexes fields will be picked up by this re-allication API. The othere fields in the payload will be ignored. If the edge-cluster-id in the payload DhcpProfile is different from the current edge-cluster-id of the profile, the referencing DHCP server(s) will be re-allocated to the new edge cluster. If the edge-cluster-id is not changed, the referencing DHCP server(s) will be re-allocated to the given edge members in the edge cluster. In this case, this REST API will act same as that of updating a DhcpProfile. If the edge cluster member indexes are provided, they should exist in the given edge cluster. If the indexes are not specified in the DhcpProfile, edge members will be auto-allocated from the given edge cluster. Please note that re-allocating edge-cluster will cause lose of all exisitng DHCP lease information. This API is used only when loosing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.

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:

serverProfileId - (required)

dhcpProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpProfile

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

reallocate

@Deprecated
void reallocate(java.lang.String serverProfileId,
                            DhcpProfile dhcpProfile,
                            com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback)

Deprecated.

As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the edge-cluster-member-indexes fields will be picked up by this re-allication API. The othere fields in the payload will be ignored. If the edge-cluster-id in the payload DhcpProfile is different from the current edge-cluster-id of the profile, the referencing DHCP server(s) will be re-allocated to the new edge cluster. If the edge-cluster-id is not changed, the referencing DHCP server(s) will be re-allocated to the given edge members in the edge cluster. In this case, this REST API will act same as that of updating a DhcpProfile. If the edge cluster member indexes are provided, they should exist in the given edge cluster. If the indexes are not specified in the DhcpProfile, edge members will be auto-allocated from the given edge cluster. Please note that re-allocating edge-cluster will cause lose of all exisitng DHCP lease information. This API is used only when loosing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.

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

Invocation Result:
com.vmware.nsx.model.DhcpProfile

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

Parameters:

serverProfileId - (required)

dhcpProfile - (required)

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

reallocate

@Deprecated
void reallocate(java.lang.String serverProfileId,
                            DhcpProfile dhcpProfile,
                            com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed, this re-allocate API is used to modify the edge-cluster-id and members of a given DhcpProfile. Only the edge-cluster-id and the edge-cluster-member-indexes fields will be picked up by this re-allication API. The othere fields in the payload will be ignored. If the edge-cluster-id in the payload DhcpProfile is different from the current edge-cluster-id of the profile, the referencing DHCP server(s) will be re-allocated to the new edge cluster. If the edge-cluster-id is not changed, the referencing DHCP server(s) will be re-allocated to the given edge members in the edge cluster. In this case, this REST API will act same as that of updating a DhcpProfile. If the edge cluster member indexes are provided, they should exist in the given edge cluster. If the indexes are not specified in the DhcpProfile, edge members will be auto-allocated from the given edge cluster. Please note that re-allocating edge-cluster will cause lose of all exisitng DHCP lease information. This API is used only when loosing DHCP leases is not a real problem, e.g. cross-site migration or failover and all client hosts will be reboot and get new IP addresses.

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

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

Parameters:

serverProfileId - (required)

dhcpProfile - (required)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
DhcpProfile update(java.lang.String profileId,
                               DhcpProfile dhcpProfile)

Deprecated.

If both the edge_cluster_member_indexes in the DhcpProfile are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a, b] to [a,y]. Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If losing leases is not a problem, a dedicated re-allocation API is suggested to modify the edge-cluster-id, i.e. \"POST /api/v1/dhcp/dhcp-profiles/?action=reallocate\". Meanwhile, if the edge_cluster_member_indexes was specified currently but now is changed to none (not specified) via a PUT operation, the edge nodes will not be auto-selected from edge cluster. Instead, the previously-allocated edge nodes will continue to be used by the DHCP server. This is because changing both edge nodes of a DHCP server will lose all existing leases. In case re-allocation is required and leases lost is not a problem (or can be recovered), please invoke the reallocate API mentioned above with new DhcpProfile to accomplish the intent.

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

Parameters:

profileId - (required)

dhcpProfile - (required)

Returns:

com.vmware.nsx.model.DhcpProfile

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

@Deprecated
DhcpProfile update(java.lang.String profileId,
                               DhcpProfile dhcpProfile,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

If both the edge_cluster_member_indexes in the DhcpProfile are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a, b] to [a,y]. Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If losing leases is not a problem, a dedicated re-allocation API is suggested to modify the edge-cluster-id, i.e. \"POST /api/v1/dhcp/dhcp-profiles/?action=reallocate\". Meanwhile, if the edge_cluster_member_indexes was specified currently but now is changed to none (not specified) via a PUT operation, the edge nodes will not be auto-selected from edge cluster. Instead, the previously-allocated edge nodes will continue to be used by the DHCP server. This is because changing both edge nodes of a DHCP server will lose all existing leases. In case re-allocation is required and leases lost is not a problem (or can be recovered), please invoke the reallocate API mentioned above with new DhcpProfile to accomplish the intent.

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:

profileId - (required)

dhcpProfile - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.DhcpProfile

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

@Deprecated
void update(java.lang.String profileId,
                        DhcpProfile dhcpProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback)

Deprecated.

If both the edge_cluster_member_indexes in the DhcpProfile are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a, b] to [a,y]. Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If losing leases is not a problem, a dedicated re-allocation API is suggested to modify the edge-cluster-id, i.e. \"POST /api/v1/dhcp/dhcp-profiles/?action=reallocate\". Meanwhile, if the edge_cluster_member_indexes was specified currently but now is changed to none (not specified) via a PUT operation, the edge nodes will not be auto-selected from edge cluster. Instead, the previously-allocated edge nodes will continue to be used by the DHCP server. This is because changing both edge nodes of a DHCP server will lose all existing leases. In case re-allocation is required and leases lost is not a problem (or can be recovered), please invoke the reallocate API mentioned above with new DhcpProfile to accomplish the intent.

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

Invocation Result:
com.vmware.nsx.model.DhcpProfile

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

Parameters:

profileId - (required)

dhcpProfile - (required)

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

update

@Deprecated
void update(java.lang.String profileId,
                        DhcpProfile dhcpProfile,
                        com.vmware.vapi.bindings.client.AsyncCallback<DhcpProfile> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

If both the edge_cluster_member_indexes in the DhcpProfile are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause the network crash due to ip conflicts. Hence the suggestion is to change only one member index in one single update, e.g. from [a, b] to [a,y]. Please note, the edge_cluster_id in DhcpProfile can NOT be changed by this PUT operation because all existing DHCP leases will lost. If losing leases is not a problem, a dedicated re-allocation API is suggested to modify the edge-cluster-id, i.e. \"POST /api/v1/dhcp/dhcp-profiles/?action=reallocate\". Meanwhile, if the edge_cluster_member_indexes was specified currently but now is changed to none (not specified) via a PUT operation, the edge nodes will not be auto-selected from edge cluster. Instead, the previously-allocated edge nodes will continue to be used by the DHCP server. This is because changing both edge nodes of a DHCP server will lose all existing leases. In case re-allocation is required and leases lost is not a problem (or can be recovered), please invoke the reallocate API mentioned above with new DhcpProfile to accomplish the intent.

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

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

Parameters:

profileId - (required)

dhcpProfile - (required)

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

invocationConfig - Configuration for the method invocation.