| Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |
Methods
Methods defined in this Service |
---|
RegisteredPhysicalMachine_Delete, RegisteredPhysicalMachine_Get, RegisteredPhysicalMachine_Register |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_MANAGEMENT | This privilege is required to delete the RegisteredPhysicalMachine. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RegisteredPhysicalMachine used to make the method call. |
id | MachineId |
The ID of the RegisteredPhysicalMachine to delete. MachineIds of
this type must originate from the
RegisteredPhysicalMachine service.
|
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_REGISTERED_PHYSICAL_MACHINE_DELETED | The RegisteredPhysicalMachine was successfully deleted. |
VLSI_REGISTERED_PHYSICAL_MACHINE_DELETE_FAILED | The RegisteredPhysicalMachine could not be deleted. |
Privileges
Privilege | Description |
---|---|
GLOBAL_CONFIG_VIEW | This privilege is required to get the RegisteredPhysicalMachineInfo. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RegisteredPhysicalMachine used to make the method call. |
id | MachineId |
The ID of the RegisteredPhysicalMachine to get. MachineIds of
this type must originate from the
RegisteredPhysicalMachine service.
|
Return Value
Type | Description |
---|---|
RegisteredPhysicalMachineInfo | The RegisteredPhysicalMachine information. |
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 a machine. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the RegisteredPhysicalMachine used to make the method call. |
spec | RegisteredPhysicalMachineRegisterSpec |
The specification for the register operation.
|
Return Value
Type | Description |
---|---|
RegisteredPhysicalMachineRegisterResult | 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_MACHINE_REGISTERED | If the machine is successfully registered. |
VLSI_MACHINE_REGISTRATION_FAILED | If the machine could not be registered. |
Top of page | Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |