Summary
Add a device to Automation Gateway
Description
This method will add a device to Automation Gateway. This method will map the variables provided in 'deviceVars' to variables used by the Automation Gateway API. Variable mappings are: 'device-type' will be mapped to 'ansible_connection', 'ipaddress' to 'ansible_host', 'port' to 'ansible_port', 'ostype' to 'ansible_network_os', 'user' to 'ansible_user', 'sshKey' to 'ansible_ssh_private_key_file', 'hostKeyChecking' to 'host_key_checking', 'provider' to 'ansible_provider', 'password' to 'ansible_password', 'become' to 'ansible_become', 'become_method' to 'ansible_become_method', 'become_pass' to 'ansible_become_pass'.
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name | Type | Required | Description |
|---|---|---|---|
| deviceName | string | yes | the name of a device |
| deviceVars | object | yes | Variables that define the connection parameters for a device. |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| result | object | the device that was created |