public interface Users extends com.vmware.vapi.bindings.Service, UsersTypes
_VAPI_SERVICE_ID
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/
|
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/
|
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/
|
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/
|
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.
|
NodeUserProperties activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty)
Synchronous method overload. Result of the invocation will be reported as a method return value.
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void activate(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
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.NodeUserProperties createaudituser(NodeUserProperties nodeUserProperties)
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.
nodeUserProperties
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.
nodeUserProperties
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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
nodeUserProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void createaudituser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
nodeUserProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.NodeUserProperties createuser(NodeUserProperties nodeUserProperties)
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.
nodeUserProperties
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.
nodeUserProperties
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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
nodeUserProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void createuser(NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
nodeUserProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.NodeUserProperties deactivate(java.lang.String userid)
Synchronous method overload. Result of the invocation will be reported as a method return value.
userid
- User id of the user (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
userid
- User id of the user (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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
userid
- User id of the user (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void deactivate(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
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.void delete(java.lang.String userid)
Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.
Synchronous method overload. Result of the invocation will be reported as a method return value.
userid
- User id of the user (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid delete(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
userid
- User id of the user (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid delete(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.
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
userid
- User id of the user (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Caution, users deleted from following node types cannot be recovered, kindly plan the removal of user accounts accordingly.
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
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.NodeUserProperties get(java.lang.String userid)
Synchronous method overload. Result of the invocation will be reported as a method return value.
userid
- User id of the user (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties get(java.lang.String userid, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
userid
- User id of the user (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid get(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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
userid
- User id of the user (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String userid, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
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.NodeUserPropertiesListResult list()
Synchronous method overload. Result of the invocation will be reported as a method return value.
com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserPropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback)
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
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.NodeUserPropertiesListResult list0()
Synchronous method overload. Result of the invocation will be reported as a method return value.
com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserPropertiesListResult list0(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback)
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
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list0(com.vmware.vapi.bindings.client.AsyncCallback<NodeUserPropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties)
Synchronous method overload. Result of the invocation will be reported as a method return value.
resetNodeUserOwnPasswordProperties
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
resetNodeUserOwnPasswordProperties
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
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
resetNodeUserOwnPasswordProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void resetownpassword(ResetNodeUserOwnPasswordProperties resetNodeUserOwnPasswordProperties, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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
resetNodeUserOwnPasswordProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty)
Synchronous method overload. Result of the invocation will be reported as a method return value.
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid resetpassword(java.lang.String userid, NodeUserPasswordProperty nodeUserPasswordProperty, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
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
userid
- User id of the user (required)nodeUserPasswordProperty
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.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)
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
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.NodeUserProperties update(java.lang.String userid, NodeUserProperties nodeUserProperties)
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-policyThe 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.
userid
- User id of the user (required)nodeUserProperties
- (required)com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNodeUserProperties update(java.lang.String userid, NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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-policyThe 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.
userid
- User id of the user (required)nodeUserProperties
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.ConcurrentChange
- Conflictcom.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid update(java.lang.String userid, NodeUserProperties nodeUserProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeUserProperties> asyncCallback)
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-policyThe 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
userid
- User id of the user (required)nodeUserProperties
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.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. 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-policyThe 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
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.