Managed Object - DrConfigConfigurationManager

Property of: DrConfigServiceInstanceContent
See also: DrConfigConfigurationManagerRegistration, DrConfigConfigurationManagerVcInfo, DrConfigConfigurationSpec, DrConfigConfigurationTask, DrConfigConnectionSpec, DrConfigHbrFilterInfo, DrConfigLogLevelInfo, DrConfigSyslogForwardInfo
Since: DrConfig API 1.0

Managed Object Description

This managed object provides tools to configure the SRM server.

Properties

Name	Type	Description
currentTask* P	ManagedObjectReference to a DrConfigConfigurationTask	Deprecated. The currently active configuration task or null.

*May not be presentP Required privilege: System.Read

Methods

Methods defined in this Managed Object
CheckRegistration, ClearSrmConfiguration, ConfigureSrm, ConfigureSyslogForwarding, ConfigureSyslogServers, DrConfigConfigurationManager_GetRunningTask, EnableSyslogLogging, GetHbrSrvNic, GetServicesSyslogLogLevel, GetSyslogServers, IsReconfigureRequired, ListVcServices, ReadCurrentConfig, SendSyslogTestMessage, SetHbrSrvNic, ValidateConnection

CheckRegistration

Check whether given extension key is already registered in SSO, lookup service and as VC extension.

Required Privileges: DrConfig.Admin
Since: DrConfig API 3.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigConfigurationManager used to make the method call.
adminUser P	xsd:string	The name of a user with sufficient privileges to perform checks. *Since* DrConfig API 3.0
adminPassword P	xsd:string	Password for the administration user. *Since* DrConfig API 3.0
connection P	DrConfigConnectionSpec	The connection specification. *Since* DrConfig API 3.0
extensionKey P	xsd:string	extensionKey for which to perform checks. This value will be returned in the result: Registration.extensionKey *Since* DrConfig API 3.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
DrConfigConfigurationManagerRegistration[]	List of existing registrations for requested extension key.

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.
DrConfigFaultInvalidLogin	Thrown if the provided credentianls are invalid.

Events

Type
None

ClearSrmConfiguration

Clears the SRM server configuration with the vSphere infrastructure.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

config P

DrConfigConfigurationSpec

The configuration specification.

Since DrConfig API 1.0

P Required privilege: config

Return Value

Type	Description
ManagedObjectReference to a DrConfigConfigurationTask	Task object that can be used to monitor the operation.

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 there is no configuration provided.
DrConfigFaultServiceBusy	Thrown if another configuration task is already running.
DrConfigFaultSrmAlreadyRunning	Thrown if SRM server is already configured and running.

Events

Type
None

ConfigureSrm

Configures the SRM server and connects it to the vSphere infrastructure.

Required Privileges: DrConfig.Admin

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

config P

DrConfigConfigurationSpec

The configuration specification.

Since DrConfig API 1.0

P Required privilege: config

Return Value

Type	Description
ManagedObjectReference to a DrConfigConfigurationTask	Task object that can be used to monitor the operation.

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 there is no configuration provided.
DrConfigFaultServiceBusy	Thrown if another configuration task is already running.
DrConfigFaultSrmAlreadyRunning	Thrown if SRM server is already configured and running.

Events

Type
None

ConfigureSyslogForwarding

Sets syslog log forwarding.

Required Privileges: DrConfig.Admin
Since: DrConfig API 1.1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigConfigurationManager used to make the method call.
enable P	xsd:boolean	True to enable log forwarding, false to disable. *Since* DrConfig API 1.1
appNames* P	xsd:string[]	List of application names for which log forwarding should be configured. Values must be one of the AppName enum. Value not used since *Since* DrConfig API 1.1
info P	DrConfigSyslogForwardInfo	*Since* DrConfig API 1.1
logLevels* P	DrConfigLogLevelInfo[]	A list of DrConfigLogLevelInfo containing information about the services syslog log levels. The last value of a duplicate service will be taken. If service is not specified a default log level of info will be set. Services need to be explicitly restarted in order for changes to take effect. *Since* DrConfig API 1.1

*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

Events

Type
None

ConfigureSyslogServers

Sets syslog log forwarding.

Required Privileges: DrConfig.Admin
Since: DrConfig API 3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

info* P

DrConfigSyslogForwardInfo[]

Since DrConfig API 3.0

logLevels* P

DrConfigLogLevelInfo[]

A list of DrConfigLogLevelInfo containing information about the services syslog log levels. The last value of a duplicate service will be taken. If service is not specified a default log level of info will be set. Services need to be explicitly restarted in order for changes to take effect.

Since DrConfig API 3.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 two of the structures contain the same server and port.
vmodl.fault.SystemError	Thrown if write to file fails.

Events

Type
None

DrConfigConfigurationManager_GetRunningTask

The currently active configuration task or null.

Required Privileges: System.Read
Since: DrConfig API 3.1

Parameters

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

Return Value

Type	Description
ManagedObjectReference to a DrConfigConfigurationTask

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

EnableSyslogLogging

Enables or disables logging to syslog.

Required Privileges: DrConfig.Admin
Since: DrConfig API 1.1

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

enable P

xsd:boolean

True to enable logging to syslog, false to disable.

Since DrConfig API 1.1

appNames* P

xsd:string[]

List of application names for which logging to syslog should be set. Values must be one of the AppName enum. App must be stopped before calling this method. Value not used since

Since DrConfig API 1.1

*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 appNames is not valid
DrConfigFaultSrmAlreadyRunning	Thrown if SRM service is already running
DrConfigFaultSrmNotConfigured	Thrown if app for which syslog logging is enabled/disabled is running. If SRM was never configured (for case when enabling syslog logging for SRM)

Events

Type
None

GetHbrSrvNic

Get the HBR filter and managment addresses.

Required Privileges: System.Read
Since: DrConfig API 5.0

Parameters

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

Return Value

Type	Description
DrConfigHbrFilterInfo	filterInfo A HbrFilterInfo data object representing the filter and managment addresses.

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

Events

Type
None

GetServicesSyslogLogLevel

Get services syslog log level info.

Required Privileges: System.Read
Since: DrConfig API 6.0

Parameters

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

Return Value

Type	Description
DrConfigLogLevelInfo[]	A list of DrConfigLogLevelInfo containing information about the services syslog log level.

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	Thrown if read file fails.

Events

Type
None

GetSyslogServers

Get syslog log forwarding info.

Required Privileges: System.Read
Since: DrConfig API 3.0

Parameters

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

Return Value

Type	Description
DrConfigSyslogForwardInfo[]	fwdInfo A list of DrConfigSyslogForwardInfo containing information about the syslog servers.

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	Thrown if read file fails.

Events

Type
None

IsReconfigureRequired

Check if reconfigure operation is required after upgrade.

Required Privileges: System.Read
Since: DrConfig API 3.0

Parameters

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

Return Value

Type	Description
xsd:boolean	boolean True if we need to reconfigure.

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

ListVcServices

List all VC in the PSC.

Required Privileges: DrConfig.Admin
Since: DrConfig API 3.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigConfigurationManager used to make the method call.
pscUri P	xsd:string	Platform Service Controller URI. *Since* DrConfig API 3.0
pscThumbprint* P	xsd:string	Thumbprint of the PSC node's certificate. When the correct value is provided all security checks of the certificate are off. *Since* DrConfig API 3.0
serviceId* P	xsd:string	Optionally narrow VC search to a specific service ID. *Since* DrConfig API 3.0

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

Return Value

Type	Description
DrConfigConfigurationManagerVcInfo[]

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 pscUri is invalid.
vmodl.fault.SystemError	Thrown if something generic failed.

Events

Type
None

ReadCurrentConfig

Reads the specification for the currently configured SRM server.

Required Privileges: System.Read

Parameters

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

Return Value

Type	Description
DrConfigConfigurationSpec

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

SendSyslogTestMessage

Send test message to all configured syslog servers.

Required Privileges: DrConfig.Admin
Since: DrConfig API 3.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

message P

xsd:string

The test message contents.

Since DrConfig API 3.0

P Required privilege: message

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	Thrown if the OS fails to send the message.

Events

Type
None

SetHbrSrvNic

Set the HBR filter and managment addresses.

Required Privileges: DrConfig.Admin
Since: DrConfig API 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterInfo P

DrConfigHbrFilterInfo

A HbrFilterInfo data object representing the filter and managment addresses.

Since DrConfig API 5.0

P Required privilege: filterInfo

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 provided addresses are not valid.
vmodl.fault.SystemError

Events

Type
None

ValidateConnection

Validates connections to the vSphere infranstructure.

Required Privileges: DrConfig.Admin
Since: DrConfig API 3.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the DrConfigConfigurationManager used to make the method call.
adminUser P	xsd:string	The name of a user with sufficient privileges to perform configuration tasks on the infrastructure and management nodes as well as SSO service configuration tasks on the infrastructure node. *Since* DrConfig API 3.0
adminPassword P	xsd:string	Password for the administration user. *Since* DrConfig API 3.0
connection P	DrConfigConnectionSpec	The connection specification. *Since* DrConfig API 3.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 some of the param is not provided or invalid.
DrConfigFaultInvalidLogin	Thrown if the provided credentianls are invalid.
DrConfigFaultSsoTokenNotAcquired	Thrown if the provided credentianls are invalid.

Events

Type
None