Service - RegisteredPhysicalMachine

Class: VMware.Hv.RegisteredPhysicalMachine
See also: MachineId, RegisteredPhysicalMachineInfo, RegisteredPhysicalMachineRegisterResult, RegisteredPhysicalMachineRegisterSpec
Since: Horizon View 6.0

Service Description

Service Interface for RegisteredPhysicalMachine. A RegisteredPhysicalMachine is a registered unmanaged physical Machine that is unassigned to any desktop.

Methods

Methods defined in this Service
RegisteredPhysicalMachine_Delete, RegisteredPhysicalMachine_Get, RegisteredPhysicalMachine_Register

RegisteredPhysicalMachine_Delete

Deletes the RegisteredPhysicalMachine for the specified machineId.

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_Delete" type="vdi:RegisteredPhysicalMachine_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_DeleteResponse">
            <complexType/>
         </element>

RegisteredPhysicalMachine_Get

Gets the RegisteredPhysicalMachineInfo object for the specified machineId.

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_Get" type="vdi:RegisteredPhysicalMachine_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RegisteredPhysicalMachineInfo"/>
               </sequence>
            </complexType>
         </element>

RegisteredPhysicalMachine_Register

Registers a machine.

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.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_Register" type="vdi:RegisteredPhysicalMachine_RegisterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="RegisteredPhysicalMachine_RegisterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:RegisteredPhysicalMachineRegisterResult"/>
               </sequence>
            </complexType>
         </element>