Managed Object - ConverterAgentManager

Property of
ConverterServerContent, ConverterWorkerContent
See also
ConverterAgentManagerAgentDeploymentResult, ConverterAgentManagerDeploymentStatus
Since
Converter API 1.0


Managed Object Description

This managed object type provides methods for agent deployment.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
ConverterInstallAgent, ConverterRebootMachine, ConverterUninstallAgent

ConverterInstallAgent

Install agent on a given host.
Required Privileges
None
Since
Converter API 2.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterAgentManager used to make the method call.
hostname Pxsd:string

NetBIOS name, DNS name, or IP address.

Since Converter API 2.0
port* Pxsd:int

The port number the remote agent will listen on.

Since Converter API 2.0
username Pxsd:string

User name with root/Administrator privileges.

Since Converter API 2.0
password Pxsd:string

Password for the user.

Since Converter API 2.0
postponeReboot* Pxsd:boolean

If true, postpone reboot if it is required by the deployment.

Since Converter API 2.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ConverterAgentManagerAgentDeploymentResultAgent deployment info.

Faults

Type Description
InvalidLoginThrown if the user and password combination is invalid.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterRebootMachine

Reboot agent machine.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterAgentManager used to make the method call.
hostname Pxsd:string

NetBIOS name, DNS name, or IP address.

Since Converter API 1.0
username Pxsd:string

User name with root/Administrator privileges.

Since Converter API 1.0
password Pxsd:string

Password for the user.

Since Converter API 1.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidLoginThrown if the user and password combination is invalid.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ConverterUninstallAgent

Uninstall agent on a given host.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ConverterAgentManager used to make the method call.
hostname Pxsd:string

NetBIOS name, DNS name, or IP address.

Since Converter API 1.0
username Pxsd:string

User name with root/Administrator privileges.

Since Converter API 1.0
password Pxsd:string

Password for the user.

Since Converter API 1.0
postponeReboot* Pxsd:boolean

If true, postpone reboot if it is required by the deployment.

Since Converter API 1.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ConverterAgentManagerDeploymentStatusAgent deployment status.

Faults

Type Description
InvalidLoginThrown if the user and password combination is invalid.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None