| Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |
Methods
Methods defined in this Service |
---|
RDSServer_Delete, RDSServer_Get, RDSServer_GetSummaryView, RDSServer_Register, RDSServer_Update |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_MANAGEMENT | privilege is required to delete RDS Server. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RDSServer used to make the method call. |
id | RDSServerId |
The entityId of RDSServer to delete
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event | Description |
---|---|
VLSI_RDSSERVER_DELETED | if the RDSServer is successfully deleted. |
VLSI_RDSSERVER_DELETE_FAILED | if the RDSServer deletion failed. |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_VIEW | is required to get an RDSServer that is not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm. |
POOL_VIEW | is required to get RDSServer that is associated with a Farm. All in-use RDSServers can be accessed with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be accessed. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RDSServer used to make the method call. |
id | RDSServerId |
The entityId of RDSServer to get
|
Return Value
Type | Description |
---|---|
RDSServerInfo | requested RDSServer entity |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_VIEW | is required to get an RDSServer that is not in-use. It is sufficient to get all RDSServers that may or may not be associated with a Farm. |
POOL_VIEW | is required to get RDSServer that is associated with a Farm. All in-use RDSServers can be accessed with POOL_VIEW on the Root access group. With POOL_VIEW privilege on a non-Root Farm access group, only the RDSServers associated with the Farm can be accessed. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RDSServer used to make the method call. |
id | RDSServerId |
The entityId of RDSServer to get
|
Return Value
Type | Description |
---|---|
RDSServerSummaryView | requested RDSServer entity |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Privileges
Privilege | Description |
---|---|
GLOBAL_MACHINE_REGISTER | Global machine registration privilege is required to register an RDS Server. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RDSServer used to make the method call. |
spec | RDSServerRegisterSpec |
The specification for the register operation.
|
Return Value
Type | Description |
---|---|
RDSServerRegisterResult | The registration result. |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event | Description |
---|---|
VLSI_RDSSERVER_REGISTERED | If the RDS Server is successfully registered. |
VLSI_RDSSERVER_REGISTRATION_FAILED | If the RDS Server could not be registered. |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_MANAGEMENT | privilege is required to update RDS Server configuration. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RDSServer used to make the method call. |
id | RDSServerId |
The entity Id of the RDS server to be updated
|
updates | MapEntry[] |
The key-value pairs describing attributes to be updated
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Events
Event | Description |
---|---|
VLSI_RDSSERVER_UPDATED | for each RDSServer attribute that was updated. |
VLSI_RDSSERVER_UPDATE_FAILED | if the RDSServer update failed. |
Top of page | Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |