Esx Agent Manager Create Agency
Creates an Agency.
The initial goal state is given to the method by the second parameter. Throws InvalidArgument if the agencyName is not set in the agencyConfigInfo.
Requires modify privileges.
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case EsxAgentManager/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"agencyConfigInfo": {},
"initialGoalState": "string"
}{
"agencyConfigInfo": {
"_typeName": "string",
"agentConfig": [
{
"_typeName": "string",
"productLineId": "string",
"hostVersion": "string",
"ovfPackageUrl": "string",
"ovfSslTrust": {
"_typeName": "string"
},
"ovfEnvironment": {
"_typeName": "string",
"ovfProperty": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
]
},
"vibUrl": "string",
"vibSslTrust": {
"_typeName": "string"
},
"vibMatchingRules": [
{
"_typeName": "string",
"vibNameRegex": "string",
"vibVersionRegex": "string"
}
],
"vibName": "string",
"dvFilterEnabled": false,
"rebootHostAfterVibUninstall": false,
"vmciService": [
"string"
],
"ovfDiskProvisioning": "string",
"vmStoragePolicies": [
{
"_typeName": "string"
}
]
}
],
"scope": {
"_typeName": "string"
},
"manuallyMarkAgentVmAvailableAfterProvisioning": false,
"manuallyMarkAgentVmAvailableAfterPowerOn": false,
"optimizedDeploymentEnabled": false,
"agentName": "string",
"agencyName": "string",
"useUuidVmName": false,
"manuallyProvisioned": false,
"manuallyMonitored": false,
"bypassVumEnabled": false,
"agentVmNetwork": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"agentVmDatastore": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"preferHostConfiguration": false,
"ipPool": {
"_typeName": "string",
"id": 0,
"name": "string",
"ipv4Config": {
"_typeName": "string",
"subnetAddress": "string",
"netmask": "string",
"gateway": "string",
"range": "string",
"dns": [
"string"
],
"dhcpServerAvailable": false,
"ipPoolEnabled": false
},
"ipv6Config": {
"_typeName": "string",
"subnetAddress": "string",
"netmask": "string",
"gateway": "string",
"range": "string",
"dns": [
"string"
],
"dhcpServerAvailable": false,
"ipPoolEnabled": false
},
"dnsDomain": "string",
"dnsSearchPath": "string",
"hostPrefix": "string",
"httpProxy": "string",
"networkAssociation": [
{
"_typeName": "string",
"network": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"networkName": "string"
}
],
"availableIpv4Addresses": 0,
"availableIpv6Addresses": 0,
"allocatedIpv4Addresses": 0,
"allocatedIpv6Addresses": 0
},
"resourcePools": [
{
"_typeName": "string",
"resourcePoolId": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"computeResourceId": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
],
"folders": [
{
"_typeName": "string",
"folderId": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"datacenterId": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
]
},
"initialGoalState": "string"
}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 OVF environment properties.
This structure may be used only with operations rendered under /eam.
Deprecated. No sence to create agency in other state than enabled. disabled is deprecated whereas uninstalled is useless. The initial goal state of the agency. See EamObjectRuntimeInfoGoalStateEnum.
The created agency.
{
"_typeName": "string",
"type": "string",
"value": "string"
}InvalidAgentConfiguration: Thrown if the agent configuration is empty or if one or more agent configurations are invalid.
InvalidAgencyScope: Thrown if one or more compute resources in the scope cannot be found in vCenter or there is no configured resource pool or folder where the VMs to be deployed.
EamInvalidUrl: Thrown if either the agent virtual machine URL or VIB URL cannot be parsed or if the resource refered to cannot be downloaded.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}