VMware NSX Controller Target Connector External API Configuration
capam32
This topic describes the required and supported Attributes used when adding or updating a VMware NSX Controller Target Application using the External API:
2
VMware NSX Controller Target Application External API Attributes
To add or update a xxx 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:
sshPort
The port that is used to connect to the UNIX host using SSH.
Required | Default Value | Valid Values |
no | 22 | 0-65535 |
sshSessionTimeout
When using the SSH communication channel, specifies the amount of time in milliseconds that Credential Manager waits for the remote host to respond.
Required | Default Value | Valid Values |
no | 5000 | 1000-99999 |
scriptTimeout
Specifies the amount of time in milliseconds that Credential Manager waits to receive some expected input from the remote host.
Required | Default Value | Valid Values |
no | 5000 | 5000-59999 |
VMware NSX Controller Target Account External API Attributes
When using the API to add a VMware NSX Controller target account, this target connector does not have any additional attributes.
VMware NSX Controller Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "NSXControllerApp", "applicationType": "nsxcontroller", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "sshPort": "", "scriptTimeout": "", "sshSessionTimeout": "" }, "passwordCompositionPolicyId": null }
VMware NSX Controller Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"nsxControllerAcc", "attributes": { "descriptor2": "", "discoveryGlobal": "f", "descriptor1": "", "discoveryAllowed": "f" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }