VMware ESX/ESXi Target Connector External API Configuration
capam32
This topic describes the required and supported Attributes used when adding or updating a VMware ESX/ESXi Target Application using the External API:
2
VMware ESX/ESXi Target Application External API Attributes
To add or update a VMware ESX/ESXi Target application using the External API, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
extensionType
Required | Default Value | Valid Values |
yes | N/A | vmwa |
sslPort
The target application port.
Required | Default Value | Valid Values |
yes | 443 | 0-65535 |
VMware ESX/ESXi Target Account External API Attributes
To add a VMware ESX/ESXi target account that uses the target connector, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
extensionType
Required | Default Value | Valid Values |
yes | N/A | vmware |
useOtherAccountToChangePassword
Specifies whether to use the target account or a different account to perform password change requests.
Required | Default Value | Valid Values |
yes | N/A | true, false |
otherAccount
Specifies which other account to use to perform password change requests.
Required | Default Value | Valid Values |
yes useOtherAccountToChangePassword is true. | N/A | A valid target account ID. |
VMware ESX/ESXi Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "vmwareApp", "applicationType": "vmware", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "mbean": "", "instance": "", "port": "", "extensionType": "vmware", "sslEnabled": "", "sslPort": "443" }, "passwordCompositionPolicyId": null }
VMware ESX/ESXi Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"vmwareAcc95", "attributes": { "otherAccount": "", "descriptor2": "", "discoveryGlobal": "f", "descriptor1": "", "discoveryAllowed": "f", "useOtherAccountToChangePassword": "false" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }
useOtherAccountToChangePassword
: "false" false/true values only