Agency Get Config
The configuration of this Agency.
Specifies how this
Agency deploys its agents and VIBs.
Requires view privileges.
The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case Agency/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
The configuration of this Agency.
"AgencyConfigInfo Object"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. If AgencyConfigInfoEx.vmPlacementPolicy is set, the array needs to contain only a single agent config. In that case the agent config is not bound to a specific host, but to the whole cluster.
Scope specifies which where to deploy agents.
This structure may be used only with operations rendered under /eam.
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 also Agent.MarkAsAvailable.
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 also Agent.MarkAsAvailable.
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.
If set to false, ESX Agent Manager will use Full VM
Cloning.
If unset default is true.
string
agentName
Optional
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.
string
agencyName
Optional
Name of the agency.
Must be set when creating the agency.
boolean
useUuidVmName
Optional
Property agentName is required if this property is set to
true.
If set to true, ESX Agent Manager will name virtual
machines with UUID suffix. For example, "example-agent-UUID".
In this case, the maximum length of agentName is 43
characters.
If not set or is set to false, virtual
machines will not contain UUID in their name.
boolean
manuallyProvisioned
Optional
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.
boolean
manuallyMonitored
Optional
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
AgencyConfigInfo.manuallyProvisioned is set to true.
boolean
bypassVumEnabled
Optional
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.
array of
object
agentVmNetwork
Optional
Specifies the networks which to be configured on the agent VMs.
This property is only applicable for pinned to host VMs - i.e.
(AgencyConfigInfoEx.vmPlacementPolicy) is not set.
If not set or AgencyConfigInfo.preferHostConfiguration is set to true, the
default host agent VM network (configured through
vim.host.EsxAgentHostManager) is used, otherwise the first network from
the array that is present on the host is used.
At most one of AgencyConfigInfo.agentVmNetwork and AgencyConfigInfoEx.vmNetworkMapping
needs to be set.
array of
object
agentVmDatastore
Optional
The datastores used to configure the storage on the agent VMs.
This property is required if AgencyConfigInfoEx.vmPlacementPolicy is set and
AgencyConfigInfoEx.datastoreSelectionPolicy is not set. In that case the first
element from the list is used.
If not set or AgencyConfigInfo.preferHostConfiguration is set to true and
AgencyConfigInfoEx.vmPlacementPolicy is not set, the default host agent VM
datastore (configured through vim.host.EsxAgentHostManager) is used,
otherwise the first datastore from the array that is present on the
host is used.
If AgencyConfigInfoEx.vmPlacementPolicy is set at most one of
AgencyConfigInfo.agentVmDatastore and AgencyConfigInfoEx.datastoreSelectionPolicy needs
to be set. If AgencyConfigInfoEx.vmPlacementPolicy is not set
AgencyConfigInfoEx.datastoreSelectionPolicy takes precedence over
AgencyConfigInfo.agentVmDatastore .
boolean
preferHostConfiguration
Optional
If set to true the default agent VM datastore and network will take
precedence over AgencyConfigInfo.agentVmNetwork and
AgencyConfigInfo.agentVmDatastore when configuring the agent
VMs.
This property is not used if AgencyConfigInfoEx.vmPlacementPolicy is set.
object
ipPool
Optional
Specifications of the network configuration to be used on a
network.
This is used to generate IP addresses and for self-customization
of vApps.
array of
object
resourcePools
Optional
Defines the resource pools where VMs to be deployed.
If specified, the VMs for every compute resouce in the scope will be
deployed to its corresponding resource pool.
If not specified, the agent VMs for each compute resource will be
deployed under top level nested resource pool created for the agent
VMs. If unable to create a nested resource pool, the root resource pool
of the compute resource will be used.
array of
object
folders
Optional
Defines the folders where VMs to be deployed.
If specified, the VMs for every compute resouce in the scope will be
deployed to its corresponding folder. The link is made between the
compute resource parent and the datacenter the folder belongs to
AgencyVMFolder.datacenterId.
If not specified, the agent VMs for each compute resource will be
deployed in top level folder created in each datacenter for the agent
VMs.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/eam/Agency/{moId}/config
Esx Agent Manager Api Operations
POST
Agency Add Issue
Deprecated
POST
Agency Destroy Agency
POST
Agency Agency Disable
Deprecated
POST
Agency Agency Enable
Deprecated
POST
Agency Query Agent
Deprecated
POST
Agency Query Config
Deprecated
POST
Agency Query Issue
POST
Agency Agency Query Runtime
Deprecated
POST
Agency Query Solution Id
Deprecated
POST
Agency Register Agent Vm
Deprecated
POST
Agency Resolve
POST
Agency Resolve All
POST
Agency Uninstall
POST
Agency Unregister Agent Vm
Deprecated
POST
Agency Update
GET
Agency Get Agent
GET
Agency Get Config
GET
Agency Get Owner
GET
Agency Get Runtime
GET
Agency Get Solution Id