type="text/javascript">








Local Properties


Managed Object TypesData Object TypesAll PropertiesAll Methods




Data Object - AgencyConfigInfo

Property of

Agency

Parameter to

CreateAgency, Update

Returned by

QueryConfig

Extends

vmodl.DynamicData

See also

AgencyScope, AgentConfigInfo, vim.Network



Data Object
Description

This is the configuration of an Agency. It determines on which compute
resources to deploy the agents, which VIB to install, which
OVF package to install, and how to configure these items by setting the DvFilter
and OVF environment properties.


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 bytes.




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

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



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

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

Set to true if agent VMs are manually provisioned. If unset, defaults to false.

Since vEAM API 2.0



optimizedDeploymentEnabled*xsd:boolean

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.




scope*AgencyScope

The scope of the Agency.





Properties inherited from vmodl.DynamicData


dynamicProperty, dynamicType


*Need not be set




Top of pageLocal Properties


Managed Object TypesData Object TypesAll PropertiesAll Methods



document.write(ID_Copyright);

document.write(ID_VersionInformation);