Managed Object - DrConfigConfigPropertiesManager

Property of: DrConfigServiceInstanceContent
See also: DrConfigServiceConfigProperty, DrConfigServiceConfigPropertyId, DrConfigServiceRestartSpec
Since: DrConfig API 6.0

Managed Object Description

This managed object provides operations to control configuration properties.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
GetContent, GetProperty, SetContent, SetProperty

GetContent

Get the whole content of the configuration file.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

service P

xsd:string

Should correspond the one of the values specified in the Service Enum in ServiceRestartSpec.java

Since DrConfig API 6.0

P Required privilege: service

Return Value

Type	Description
xsd:string

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	Thrown if the config file is not supported.
vmodl.fault.SystemError	General read error.

Events

Type
None

GetProperty

Retrieve properties.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

retrieveSpec* P

DrConfigServiceConfigPropertyId[]

ServiceConfigPropertyId Array with the data paths for the requested properties. If empty or unset no properties will be retrieved.

Since DrConfig API 6.0

*Need not be set P Required privilege: retrieveSpec

Return Value

Type	Description
DrConfigServiceConfigProperty[]	ServiceConfigProperty Array with the filtered properties.

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	Thrown if config file is not supported.
vmodl.fault.SystemError	General read error.

Events

Type
None

SetContent

Set the whole content of the configuration file.

Required Privileges: DrConfig.Admin

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigConfigPropertiesManager used to make the method call.
content P	xsd:string	Content of the service configuration file. *Since* DrConfig API 6.0
service P	DrConfigServiceRestartSpec	ServiceRestartSpec specifing which service to be modified and whether or not to be restarted *Since* DrConfig API 6.0
version P	xsd:string	sha256 hash of the contents of the service config file before write. *Since* DrConfig API 6.0

PRequired privilege - see tooltip for details

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	Thrown if the config file is not supported.
vmodl.fault.SystemError	General write error.
DrConfigFaultConcurrentWriteFault	Thrown if the config file has been modified since your last read from this file.

Events

Type
None

SetProperty

Set properties.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

updateSpec* P

DrConfigServiceConfigProperty[]

ServiceConfigProperty Array with the data paths for the requested properties with the corresponding values. If empty no update will be done.

Since DrConfig API 6.0

restartSpec* P

DrConfigServiceRestartSpec[]

ServiceRestartSpec Array with the data specifing which service to be restarted. If empty or unset no restarts will be done.

Since DrConfig API 6.0

*Need not be set PRequired privilege - see tooltip for details

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	Thrown if the config file is not supported.
vmodl.fault.SystemError	General read/write error.
DrConfigFaultConcurrentWriteFault	Thrown if the config file is out of sync. The contents of the config file has been changed since your last read from this file.

Events

Type
None