vSphere ESX Agent Manager API


Data Object - AgentConfigInfo

Property of
AgencyConfigInfo, Agent, InvalidAgentConfiguration
Returned by
AgentQueryConfig
Extends
vmodl.DynamicData
See also
AgentOvfEnvironmentInfo, AgentSslTrust, AgentStoragePolicy, AgentVibMatchingRule
Since
1.0

Data Object Description

Deprecated. as of vSphere 9.0. Please refer to vLCM APIs.

A description of what should be put on a host. By setting the productLineId and hostVersion, you can specify the types of hosts for which to use the ConfigInfo.

Properties

Name Type Description
authenticationScheme*xsd:string

The authentication scheme needed to access the OVF URL.

The supported schemes are listed in AuthenticationSceme Default value is AuthenticationScheme#NONE if not specified.

If the scheme is not {@code null} and is not set to AuthenticationScheme#NONE then ovfPackageUrl must point to the VC

Since vEAM API 9.0
dvFilterEnabled*xsd:boolean

Deprecated. that is a custom setup specific for a particular agency. The agency owner should do it using other means, e.g. manuallyMarkAgentVmAvailableAfterPowerOn or manuallyMarkAgentVmAvailableAfterProvisioning hooks. Support for this has been removed. Seting this to true will no longer have any effect.

If set to true, the hosts in the scope must be configured for DvFilter before VIBs and agent virtual machines are deployed on them. If not set or set to false, no DvFilter configuration is done on the hosts.
hostVersion*xsd:string

A dot-separated string of the host version. Examples of values are "4.1.0" "3.5", "4.*" where * is a wildcard meaning any version minor version of the major version 4. If omitted, the host version will not be considered when matching an AgentPackage against a host. This property is not used if vmPlacementPolicy is set. It is client's responsibility to trigger an agency upgrade with a new ovfPackageUrl.
ovfDiskProvisioning*xsd:string

AgentVM disk provisioning type.

Defaults to OvfDiskProvisioning#none if not specified.

Since vEAM API 6.9
ovfEnvironment*AgentOvfEnvironmentInfo

The part of the OVF environment that can be set by the solution. This is where Properties that the agent virtual machine's OVF descriptor specifies are set here. All properties that are specified as user-configurable must be set.
ovfPackageUrl*xsd:string

The URL of the solution's agent OVF package. If not set, no agent virtual machines are installed on the hosts covered by the scope. If vmPlacementPolicy is set, the VM needs to be agnostic to the different host versions inside the cluster.
ovfSslTrust*AgentSslTrust

Specifies an SSL trust policy to be use for verification of the server that hosts the ovfPackageUrl. If not set, the server certificate is validated against the trusted root certificates of the OS (Photon) and VECS (TRUSTED_ROOTS).

Since vEAM API 8.2
productLineId*xsd:string

The product line ID of the host. Examples of values are "esx" or "embeddedEsx". If omitted, the host's product line ID is not considered when matching an AgentPackage against a host.
rebootHostAfterVibUninstall*xsd:boolean

Deprecated. express that requirement in the VIB descriptor with 'live-remove-allowed=false'

An optional boolean flag to specify whether the agent's host is rebooted after the VIB is uninstalled. If not set, the default value is false. If set to true, the agent gets a VibRequiresHostReboot issue after a successful uninstallation.
vibMatchingRules*AgentVibMatchingRule[]

Deprecated. VIB matching rules are no longer supported by EAM. Same overlaps with VIB dependency requirements which reside in each VIB's metadata.

Optional Vib matching rules. If set, the Vib, specified by vibUrl, will be installed either
  • if there is installed Vib on the host which name and version match the regular expressions in the corresponding rule
  • or there isn't any installed Vib on the host with name which matches the Vib name regular expression in the corresponding rule. Vib matching rules are usually used for controlling VIB upgrades, in which case the name regular expression matches any previous versions of the agency Vib and version regular expression determines whether the existing Vib should be upgraded.
For every Vib in the Vib package, only one Vib matching rule can be defined. If specified more than one, it is not determined which one will be used. The Vib name regular expression in the Vib matching rule will be matched against the name of the Vib which will be installed. Only rules for Vibs which are defined in the Vib package metadata will be taken in account.

Since vEAM API 2_5
vibName*xsd:string

Deprecated. Use VIB metadata to add such dependency

An optional name of a VIB. If set, no VIB is installed on the host. The host is checked if a VIB with vibName is already installed on it. Also the vibUrl must not be set together with the vibUrl.

Since vEAM API 2.0
vibSslTrust*AgentSslTrust

Specifies an SSL trust policy to be use for verification of the server that hosts the vibUrl. If not set, the server certificate is validated against the trusted root certificates of the OS (Photon) and VECS (TRUSTED_ROOTS).

Since vEAM API 8.2
vibUrl*xsd:string

An optional URL to an offline bundle. If not set, no VIB is installed on the hosts in the scope. Offline bundles are only supported on 4.0 hosts and later.

VIB downgrade is not permitted - in case a VIB with the same name, but lower version is installed on a host in the scope the VIB installation on that host will not succeed.

If two or more agents have the same VIB with different versions on the same host, the install/uninstall behaviour is undefined (the VIB may remain installed, etc.).

The property is not used if vmPlacementPolicy is set.


vmciService*xsd:string[]

If set the virtual machine will be configured with the services and allow VMCI access from the virtual machine to the installed VIB.
vmResourceConfiguration*xsd:string

Specifies the resource configuration to be used when deploying an Agent VM. It must correspond to the Configuration element of the DeploymentOptionSection in the OVF specification.

Since vEAM API 8.3
vmStoragePolicies*AgentStoragePolicy[]

Defines the storage policies configured on Agent VMs. Storage policies are configured on all VM related objects including disks. NOTE: The property needs to be configured on each update, otherwise vSphere ESX Agent Manager will unset this configuration for all future agent VMs.

Since vEAM API 7.0
Properties inherited from vmodl.DynamicData
None
*Need not be set
Show WSDL type definition