com.vmware.nsx.node

Class UsersStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.node.UsersStub

All Implemented Interfaces:

Users, UsersTypes, com.vmware.vapi.bindings.Service

public class UsersStub
extends com.vmware.vapi.internal.bindings.Stub
implements Users

Remote stub implementation of the Users API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.node.UsersTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
UsersStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
UsersStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
NodeUserProperties	activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty) Activates the account for this user.
void	activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Activates the account for this user.
void	activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Activates the account for this user.
NodeUserProperties	activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Activates the account for this user.
NodeUserProperties	createaudituser(NodeUserProperties nodeUserProperties) Create new user account to log in to the NSX web-based user interface or access API.
void	createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Create new user account to log in to the NSX web-based user interface or access API.
void	createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create new user account to log in to the NSX web-based user interface or access API.
NodeUserProperties	createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create new user account to log in to the NSX web-based user interface or access API.
NodeUserProperties	createuser(NodeUserProperties nodeUserProperties) Create new user account to log in to the NSX web-based user interface or access API.
void	createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Create new user account to log in to the NSX web-based user interface or access API.
void	createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create new user account to log in to the NSX web-based user interface or access API.
NodeUserProperties	createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create new user account to log in to the NSX web-based user interface or access API.
NodeUserProperties	deactivate(java.lang.String userid) Deactivates the account for this user.
void	deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Deactivates the account for this user.
void	deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deactivates the account for this user.
NodeUserProperties	deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deactivates the account for this user.
void	delete(java.lang.String userid) Delete specified user who is configured to log in to the NSX appliance.
void	delete(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete specified user who is configured to log in to the NSX appliance.
void	delete(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete specified user who is configured to log in to the NSX appliance.
void	delete(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete specified user who is configured to log in to the NSX appliance.
NodeUserProperties	get(java.lang.String userid) Returns information about a specified user who is configured to log in to the NSX appliance.
void	get(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Returns information about a specified user who is configured to log in to the NSX appliance.
void	get(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified user who is configured to log in to the NSX appliance.
NodeUserProperties	get(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified user who is configured to log in to the NSX appliance.
NodeUserPropertiesListResult	list() Returns the list of users configured to log in to the NSX appliance.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback) Returns the list of users configured to log in to the NSX appliance.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of users configured to log in to the NSX appliance.
NodeUserPropertiesListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of users configured to log in to the NSX appliance.
NodeUserPropertiesListResult	list0() Returns the list of users configured to log in to the NSX appliance.
void	list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback) Returns the list of users configured to log in to the NSX appliance.
void	list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of users configured to log in to the NSX appliance.
NodeUserPropertiesListResult	list0(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the list of users configured to log in to the NSX appliance.
void	resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties) Enables a user to reset their own password.
void	resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Enables a user to reset their own password.
void	resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Enables a user to reset their own password.
void	resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Enables a user to reset their own password.
void	resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty) Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided.
void	resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided.
void	resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided.
void	resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided.
NodeUserProperties	update(java.lang.String userid, NodeUserProperties nodeUserProperties) Updates attributes of an existing NSX appliance user.
void	update(java.lang.String userid, NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback) Updates attributes of an existing NSX appliance user.
void	update(java.lang.String userid, NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates attributes of an existing NSX appliance user.
NodeUserProperties	update(java.lang.String userid, NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates attributes of an existing NSX appliance user.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UsersStub

public UsersStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

UsersStub

public UsersStub(com.vmware.vapi.core.ApiProvider apiProvider,
                 com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

activate

public NodeUserProperties activate(java.lang.String userid,
                                   NodeUserPasswordProperty nodeUserPasswordProperty)

Description copied from interface: Users

Activates the account for this user. When an account is successfully activated, the \"status\" field in the response is \"ACTIVE\". This API is not supported for userid 0 and userid 10000.

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

Specified by:

activate in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

activate

public NodeUserProperties activate(java.lang.String userid,
                                   NodeUserPasswordProperty nodeUserPasswordProperty,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Activates the account for this user. When an account is successfully activated, the \"status\" field in the response is \"ACTIVE\". This API is not supported for userid 0 and userid 10000.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

activate in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

activate

public void activate(java.lang.String userid,
                     NodeUserPasswordProperty nodeUserPasswordProperty,
                     com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Activates the account for this user. When an account is successfully activated, the \"status\" field in the response is \"ACTIVE\". This API is not supported for userid 0 and userid 10000.

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

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

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

Specified by:

activate in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

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

activate

public void activate(java.lang.String userid,
                     NodeUserPasswordProperty nodeUserPasswordProperty,
                     com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Activates the account for this user. When an account is successfully activated, the \"status\" field in the response is \"ACTIVE\". This API is not supported for userid 0 and userid 10000.

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

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

Specified by:

activate in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

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

invocationConfig - Configuration for the method invocation.

createaudituser

public NodeUserProperties createaudituser(NodeUserProperties nodeUserProperties)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

Specified by:

createaudituser in interface Users

Parameters:

nodeUserProperties - (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

createaudituser

public NodeUserProperties createaudituser(NodeUserProperties nodeUserProperties,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

createaudituser in interface Users

Parameters:

nodeUserProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

createaudituser

public void createaudituser(NodeUserProperties nodeUserProperties,
                            com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

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

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

Specified by:

createaudituser in interface Users

Parameters:

nodeUserProperties - (required)

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

createaudituser

public void createaudituser(NodeUserProperties nodeUserProperties,
                            com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

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

Specified by:

createaudituser in interface Users

Parameters:

nodeUserProperties - (required)

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

invocationConfig - Configuration for the method invocation.

createuser

public NodeUserProperties createuser(NodeUserProperties nodeUserProperties)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

Specified by:

createuser in interface Users

Parameters:

nodeUserProperties - (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

createuser

public NodeUserProperties createuser(NodeUserProperties nodeUserProperties,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

createuser in interface Users

Parameters:

nodeUserProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

createuser

public void createuser(NodeUserProperties nodeUserProperties,
                       com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

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

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

Specified by:

createuser in interface Users

Parameters:

nodeUserProperties - (required)

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

createuser

public void createuser(NodeUserProperties nodeUserProperties,
                       com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Create new user account to log in to the NSX web-based user interface or access API. username is required field in case of creating new user, further following usernames - root, admin, audit are reserved and can not be used to create new user account unless for local audit user. In case of local audit account when username not specified in request by default account will be created with audit username, although administrators are allowed to use any other non-duplicate usernames during creation.

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

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

Specified by:

createuser in interface Users

Parameters:

nodeUserProperties - (required)

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

invocationConfig - Configuration for the method invocation.

deactivate

public NodeUserProperties deactivate(java.lang.String userid)

Description copied from interface: Users

Deactivates the account for this user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated. When an account is successfully deactivated, the \"status\" field in the response is \"NOT_ACTIVATED\". This API is not supported for userid 0 and userid 10000.

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

Specified by:

deactivate in interface Users

Parameters:

userid - User id of the user (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

deactivate

public NodeUserProperties deactivate(java.lang.String userid,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Deactivates the account for this user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated. When an account is successfully deactivated, the \"status\" field in the response is \"NOT_ACTIVATED\". This API is not supported for userid 0 and userid 10000.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

deactivate in interface Users

Parameters:

userid - User id of the user (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

deactivate

public void deactivate(java.lang.String userid,
                       com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Deactivates the account for this user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated. When an account is successfully deactivated, the \"status\" field in the response is \"NOT_ACTIVATED\". This API is not supported for userid 0 and userid 10000.

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

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

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

Specified by:

deactivate in interface Users

Parameters:

userid - User id of the user (required)

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

deactivate

public void deactivate(java.lang.String userid,
                       com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Deactivates the account for this user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated. When an account is successfully deactivated, the \"status\" field in the response is \"NOT_ACTIVATED\". This API is not supported for userid 0 and userid 10000.

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

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

Specified by:

deactivate in interface Users

Parameters:

userid - User id of the user (required)

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String userid)

Description copied from interface: Users

Delete specified user who is configured to log in to the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand.

Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.

• Autonomous Edge
• Cloud Service Manager
• Edge
• Public Cloud Gateway

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

Specified by:

delete in interface Users

Parameters:

userid - User id of the user (required)

delete

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

Description copied from interface: Users

Delete specified user who is configured to log in to the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand.

Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.

• Autonomous Edge
• Cloud Service Manager
• Edge
• Public Cloud Gateway

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface Users

Parameters:

userid - User id of the user (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: Users

Delete specified user who is configured to log in to the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand.

Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.

• Autonomous Edge
• Cloud Service Manager
• Edge
• Public Cloud Gateway

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

Specified by:

delete in interface Users

Parameters:

userid - User id of the user (required)

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

delete

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

Description copied from interface: Users

Delete specified user who is configured to log in to the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand.

Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.

• Autonomous Edge
• Cloud Service Manager
• Edge
• Public Cloud Gateway

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

Specified by:

delete in interface Users

Parameters:

userid - User id of the user (required)

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

invocationConfig - Configuration for the method invocation.

get

public NodeUserProperties get(java.lang.String userid)

Description copied from interface: Users

Returns information about a specified user who is configured to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.

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

Specified by:

get in interface Users

Parameters:

userid - User id of the user (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

get

public NodeUserProperties get(java.lang.String userid,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Returns information about a specified user who is configured to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Users

Parameters:

userid - User id of the user (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

get

public void get(java.lang.String userid,
                com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Returns information about a specified user who is configured to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.

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

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

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

Specified by:

get in interface Users

Parameters:

userid - User id of the user (required)

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

get

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

Description copied from interface: Users

Returns information about a specified user who is configured to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.

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

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

Specified by:

get in interface Users

Parameters:

userid - User id of the user (required)

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

invocationConfig - Configuration for the method invocation.

list

public NodeUserPropertiesListResult list()

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

Specified by:

list in interface Users

Returns:

com.vmware.nsx.model.NodeUserPropertiesListResult

list

public NodeUserPropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Users

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserPropertiesListResult

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

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

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

Specified by:

list in interface Users

Parameters:

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

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

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

Specified by:

list in interface Users

Parameters:

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

invocationConfig - Configuration for the method invocation.

list0

public NodeUserPropertiesListResult list0()

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

Specified by:

list0 in interface Users

Returns:

com.vmware.nsx.model.NodeUserPropertiesListResult

list0

public NodeUserPropertiesListResult list0(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list0 in interface Users

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserPropertiesListResult

list0

public void list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

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

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

Specified by:

list0 in interface Users

Parameters:

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

list0

public void list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Returns the list of users configured to log in to the NSX appliance.

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

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

Specified by:

list0 in interface Users

Parameters:

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

invocationConfig - Configuration for the method invocation.

resetownpassword

public void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties)

Description copied from interface: Users

Enables a user to reset their own password.

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

Specified by:

resetownpassword in interface Users

Parameters:

resetNodeUserOwnPasswordProperties - (required)

resetownpassword

public void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Enables a user to reset their own password.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

resetownpassword in interface Users

Parameters:

resetNodeUserOwnPasswordProperties - (required)

invocationConfig - Configuration for the method invocation.

resetownpassword

public void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties,
                             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Users

Enables a user to reset their own password.

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

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

Specified by:

resetownpassword in interface Users

Parameters:

resetNodeUserOwnPasswordProperties - (required)

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

resetownpassword

public void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties,
                             com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Enables a user to reset their own password.

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

Specified by:

resetownpassword in interface Users

Parameters:

resetNodeUserOwnPasswordProperties - (required)

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

invocationConfig - Configuration for the method invocation.

resetpassword

public void resetpassword(java.lang.String userid,
                          NodeUserPasswordProperty nodeUserPasswordProperty)

Description copied from interface: Users

Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided. The account of the target user must be \"ACTIVE\" for the call to succeed. This API is not supported for userid 0 and userid 10000.

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

Specified by:

resetpassword in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

resetpassword

public void resetpassword(java.lang.String userid,
                          NodeUserPasswordProperty nodeUserPasswordProperty,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided. The account of the target user must be \"ACTIVE\" for the call to succeed. This API is not supported for userid 0 and userid 10000.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

resetpassword in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

invocationConfig - Configuration for the method invocation.

resetpassword

public void resetpassword(java.lang.String userid,
                          NodeUserPasswordProperty nodeUserPasswordProperty,
                          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Users

Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided. The account of the target user must be \"ACTIVE\" for the call to succeed. This API is not supported for userid 0 and userid 10000.

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

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

Specified by:

resetpassword in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

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

resetpassword

public void resetpassword(java.lang.String userid,
                          NodeUserPasswordProperty nodeUserPasswordProperty,
                          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Unlike the PUT version of this call (PUT /node/users/), this API does not require that the current password for the user be provided. The account of the target user must be \"ACTIVE\" for the call to succeed. This API is not supported for userid 0 and userid 10000.

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

Specified by:

resetpassword in interface Users

Parameters:

userid - User id of the user (required)

nodeUserPasswordProperty - (required)

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

invocationConfig - Configuration for the method invocation.

update

public NodeUserProperties update(java.lang.String userid,
                                 NodeUserProperties nodeUserProperties)

Description copied from interface: Users

Updates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request.

The specified password does not meet the following (default) complexity requirements: - minimum 12 characters in length - minimum 128 characters in length - minimum 1 uppercase character - minimum 1 lowercase character - minimum 1 numeric character - minimum 1 special character - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module

the configured password complexity may vary as per defined Authentication and Password policies, which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries.

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

Specified by:

update in interface Users

Parameters:

userid - User id of the user (required)

nodeUserProperties - (required)

Returns:

com.vmware.nsx.model.NodeUserProperties

update

public NodeUserProperties update(java.lang.String userid,
                                 NodeUserProperties nodeUserProperties,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Updates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request.

The specified password does not meet the following (default) complexity requirements: - minimum 12 characters in length - minimum 128 characters in length - minimum 1 uppercase character - minimum 1 lowercase character - minimum 1 numeric character - minimum 1 special character - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module

the configured password complexity may vary as per defined Authentication and Password policies, which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Users

Parameters:

userid - User id of the user (required)

nodeUserProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeUserProperties

update

public void update(java.lang.String userid,
                   NodeUserProperties nodeUserProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)

Description copied from interface: Users

Updates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request.

The specified password does not meet the following (default) complexity requirements: - minimum 12 characters in length - minimum 128 characters in length - minimum 1 uppercase character - minimum 1 lowercase character - minimum 1 numeric character - minimum 1 special character - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module

the configured password complexity may vary as per defined Authentication and Password policies, which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries.

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

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

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

Specified by:

update in interface Users

Parameters:

userid - User id of the user (required)

nodeUserProperties - (required)

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

update

public void update(java.lang.String userid,
                   NodeUserProperties nodeUserProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Users

Updates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request.

The specified password does not meet the following (default) complexity requirements: - minimum 12 characters in length - minimum 128 characters in length - minimum 1 uppercase character - minimum 1 lowercase character - minimum 1 numeric character - minimum 1 special character - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module

the configured password complexity may vary as per defined Authentication and Password policies, which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries.

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

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

Specified by:

update in interface Users

Parameters:

userid - User id of the user (required)

nodeUserProperties - (required)

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

invocationConfig - Configuration for the method invocation.