|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
| Name | Type | Description |
|---|---|---|
| agencyName* | xsd:string |
Name of the agency. Must be set when creating the agency.
|
| agentConfig* | AgentConfigInfo[] |
A list of AgentConfigInfos for hosts covered by this
Agency. When provisioning a new agent to a host, vSphere
ESX Agent Manager tries to find, from left to right in the array, a
match for an AgentConfigInfo and stops searching at the first
one that it finds.
|
| agentName* | xsd:string |
An optional name to use when naming agent virtual machines. For
example, if set to "example-agent", each agent virtual machine will be
named "example-agent (1)", "example-agent (2)", and so on. The maximum
length of agentName is 70 characters.
|
| agentVmDatastore* | vmodl.ManagedObjectReference
to a vim.Datastore |
If unset, the default agent VM datastore on the host is used to
configure the agent VM storage.
If set, the datastores are used to configure the storage on the agent
VMs. The array is scanned per host and the first datastore that is
present on the host is used. Moreover, the agent VM datastores
configured per host will be ignored and solutions are required to add
each host in the agency scope to one of the configured datastores.
Since vEAM API 2_5 |
| agentVmNetwork* | vmodl.ManagedObjectReference
to a vim.Network |
If unset, the default agent VM network on the host is used to configure
the agent VM management network.
If set, the networks are used to configure management network on agent
VMs. The array is scanned per host and the first network that is
present on the host is used. Moreover, the agent VM networks configured
per host will be ignored and solutions are required to add each host in
the agency scope to one of the configured networks.
Since vEAM API 2.0 |
| bypassVumEnabled* | xsd:boolean | Deprecated.
VUM is no more consulted so this property has no sense
anymore
Set to true will install VIBs directly on the hosts even if VMware
Update Manager is installed. If unset, defaults to false.
Since vEAM API 2.0 |
| ipPool* | vim.vApp.IpPool | Deprecated.
that is a custom configuration that should be setup by the
agency owner. One way is to use
manuallyMarkAgentVmAvailableAfterPowerOn or
manuallyMarkAgentVmAvailableAfterProvisioning
hooks.
If set, a property with id "ip" and value an IP from the pool is added
to the vApp configuration of the deployed VMs.
Since vEAM API 3.0 |
| manuallyMarkAgentVmAvailableAfterPowerOn* | xsd:boolean |
If set to true, the client of this agency must manually
mark the agent as ready after the agent virtual machine has been
powered on. In this case, DRS will not regard the agent virtual machine
as ready until the client has marked the agent as ready.See Agent#markAsAvailable() |
| manuallyMarkAgentVmAvailableAfterProvisioning* | xsd:boolean |
If set to true, the client of this agency must manually
mark the agent as ready after the agent virtual machine has been
provisioned. This is useful if the client of this solution performs
some extra reconfiguration of the agent virtual machine before it is
powered on.See Agent#markAsAvailable() |
| manuallyMonitored* | xsd:boolean | Deprecated.
use automatically provisioned VMs and register hooks to
have control post provisioning and power on
Set to true if agent VMs are manually monitored. If unset, defaults to
false. This can only be set to true if
manuallyProvisioned is set to true.
Since vEAM API 2.0 |
| manuallyProvisioned* | xsd:boolean | Deprecated.
use automatically provisioned VMs and register hooks to
have control post provisioning and power on
Set to true if agent VMs are manually provisioned. If unset, defaults
to false.
Since vEAM API 2.0 |
| optimizedDeploymentEnabled* | xsd:boolean | Deprecated.
no sense to disable linked clones
If set to true, ESX Agent Manager will use vSphere Linked
Clones to speed up the deployment of agent virtual machines. Using
linked clones implies that the agent virtual machines cannot use
Storage vMotion to move to another vSphere datastore.
|
| preferHostConfiguration* | xsd:boolean |
If set to true the default agent VM datastore and network will take
precedence over Agency.ConfigInfo.agentVmNetwork and
Agency.ConfigInfo.agentVmDatastore when configuring the agent
VMs.
Since vEAM API 2_5 |
| scope* | AgencyScope |
The scope of the Agency.
|
| Properties inherited from vmodl.DynamicData | ||
| None | ||
| Top of page | Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |