# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterAgentManager used to make the method call.
hostname P | xsd:string | NetBIOS name, DNS name, or IP address. Since Converter API 2.0
port* P | xsd:int | The port number the remote agent will listen on. Since Converter API 2.0
username P | xsd:string | User name with root/Administrator privileges. Since Converter API 2.0
password P | xsd:string | Password for the user. Since Converter API 2.0
postponeReboot* P | xsd:boolean | If true, postpone reboot if it is required by the deployment. Since Converter API 2.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ConverterAgentManagerAgentDeploymentResult | Agent deployment info.

Faults

Type | Description
--- | ---
InvalidLogin | Thrown if the user and password combination is invalid.
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

# ConverterRebootMachine

Reboot agent machine.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterAgentManager used to make the method call.
hostname P | xsd:string | NetBIOS name, DNS name, or IP address. Since Converter API 1.0
username P | xsd:string | User name with root/Administrator privileges. Since Converter API 1.0
password P | xsd:string | Password for the user. Since Converter API 1.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
InvalidLogin | Thrown if the user and password combination is invalid.
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

# ConverterUninstallAgent

Uninstall agent on a given host.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ConverterAgentManager used to make the method call.
hostname P | xsd:string | NetBIOS name, DNS name, or IP address. Since Converter API 1.0
username P | xsd:string | User name with root/Administrator privileges. Since Converter API 1.0
password P | xsd:string | Password for the user. Since Converter API 1.0
postponeReboot* P | xsd:boolean | If true, postpone reboot if it is required by the deployment. Since Converter API 1.0

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ConverterAgentManagerDeploymentStatus | Agent deployment status.

Faults

Type | Description
--- | ---
InvalidLogin | Thrown if the user and password combination is invalid.
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