Managed Object - DrConfigApplianceManager

Property of: DrConfigServiceInstanceContent
See also: DrConfigApplianceManagerApplianceInfo, DrConfigDiskInfo, DrConfigNetworkInfo, DrConfigTimeSyncInfo
Since: DrConfig API 3.0

Managed Object Description

This managed object provides tools to manipulate the appliance of SRM server.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
GetAllTimeZones, GetCurrentDateTime, GetCurrentTimeZone, GetDiskInfo, GetInfo, GetNetworkInfo, GetTimeSyncConfig, Restart, SetCurrentTimeZone, SetNetworkInfo, SetTimeSync, Stop

GetAllTimeZones

Get all avaivable time zones.

Required Privileges: System.Anonymous

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
xsd:string[]	A list representing all avaivable time zones.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetCurrentDateTime

Get appliance current date and time

Required Privileges: System.Anonymous

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
xsd:dateTime	A DateTime object with the appliance date and time.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetCurrentTimeZone

Get appliance current time zone.

Required Privileges: System.Anonymous

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
xsd:string	A string representing the current time zone.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetDiskInfo

Retrieves appliance disks information.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
DrConfigDiskInfo[]	A DrConfigDiskInfo object which contains disk information about the appliance.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetInfo

Retrieves appliance information.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
DrConfigApplianceManagerApplianceInfo	A ApplianceInfo object which contains info about the appliance.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetNetworkInfo

Retrieves appliance network information.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
DrConfigNetworkInfo	A DrConfigNetworkInfo object which contains network information about the appliance.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

GetTimeSyncConfig

Get appliance time sync mode.

Required Privileges: System.Anonymous

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
DrConfigTimeSyncInfo	A DrConfigTimeSyncInfo object representing the timeSyncMode.

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Restart

Restarts the appliance.

Required Privileges: DrConfig.Admin

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

SetCurrentTimeZone

Set appliance time zone.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the DrConfigApplianceManager used to make the method call.

timeZone P

xsd:string

Since DrConfig API 3.0

P Required privilege: timeZone

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument

Events

Type
None

SetNetworkInfo

Set appliance network information.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the DrConfigApplianceManager used to make the method call.

networkInfo P

DrConfigNetworkInfo

Since DrConfig API 3.0

P Required privilege: networkInfo

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.InvalidArgument
vmodl.fault.SystemError

Events

Type
None

SetTimeSync

Set appliance time sync information

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the DrConfigApplianceManager used to make the method call.

timeSyncInfo P

DrConfigTimeSyncInfo

Since DrConfig API 3.0

P Required privilege: timeSyncInfo

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.SystemError
vmodl.fault.InvalidArgument
DrConfigFaultHostUnreachableFault	Thrown if ntp server could not be contacted.

Events

Type
None

Stop

Stop the appliance.

Required Privileges: DrConfig.Admin

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigApplianceManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
vmodl.RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None