-
addDeviceToDeviceGroup
Add a device to a device group in Automation Gateway
No Northbound API AvailableThis method will add a device to a device group in Automation Gateway
-
applyTerraform
Apply terraform module on Automation Gateway
No Northbound API AvailableThis method will apply a module in Automation Gateway
-
connectDevice
Whether the device is alive
No Northbound API AvailableThis method will retrieve the status of the device in Automation Gateway
-
createDevice
Add a device to Automation Gateway
No Northbound API AvailableThis 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', 'ansibleOS' to 'ansible_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'.
-
createDeviceGroup
Add a device group to Automation Gateway
No Northbound API AvailableThis method will add a device group to Automation Gateway
-
createDeviceRaw
Add a device to Automation Gateway without manipulation of variables
No Northbound API AvailableThis method will add a device to Automation Gateway. This method will not map the variables provided instead it will forward the variables as-is to the underlying api.
-
createInventoryDevice
Create an Inventory device
POST /automationgateway/createInventoryDeviceCreate an Inventory device
-
deleteDevice
Remove a device from Automation Gateway
No Northbound API AvailableThis method will remove a device from Automation Gateway
-
deleteDeviceFromDeviceGroup
Remove a device from a device group in Automation Gateway
No Northbound API AvailableThis method will remove a device from a device group in Automation Gateway
-
deleteDeviceGroup
Remove a device group from Automation Gateway
No Northbound API AvailableThis method will remove a device group from Automation Gateway
-
deleteInventoryDevice
Delete an inventory device.
DELETE /automationgateway/deleteInventoryDeviceDelete an inventory device.
-
destroyTerraform
Destroy terraform module on Automation Gateway
No Northbound API AvailableThis method will destroy a module in Automation Gateway
-
dryRunPlaybook
Dry Run a playbook in Automation Gateway with check mode
No Northbound API AvailableThis method will run a playbook in Automation Gateway with check mode i.e Dry Run
-
getCollectionModule
Get a module from a collection in Automation Gateway
No Northbound API AvailableThis method will get a module from a collection in Automation Gateway
-
getCollectionModules
Get modules from a collection install in Automation Gateway
No Northbound API AvailableThis method will get all modules from a collection on Automation Gateway
-
getCollectionRole
Get a particular role from a collection in Automation Gateway
No Northbound API AvailableThis method will get a particular role from a collection in Automation Gateway
-
getCollectionRoles
Get roles from a collection install in Automation Gateway
No Northbound API AvailableThis method will get all roles from a collection on Automation Gateway
-
getCollections
Get collections installed in Automation Gateway
No Northbound API AvailableThis method will get all collections installed on Automation Gateway
-
getConfig
Get the configuration of a device from Automation Gateway
No Northbound API AvailableThis method will retrieve the configuration of a device from Automation Gateway
-
getDevice
Get a particular device from Automation Gateway
No Northbound API AvailableThis method will get a particular device from Automation Gateway
-
getDeviceDetailsRaw
Get a particular device raw details from Automation Gateway
No Northbound API AvailableThis method will get a particular device raw details from Automation Gateway
-
getDeviceGroup
Get a particular device group from Automation Gateway
No Northbound API AvailableThis method will get a particular device group from Automation Gateway
-
getDeviceGroups
Get device groups from Automation Gateway
No Northbound API AvailableThis method will get all device groups from Automation Gateway
-
getDeviceHealth
Retrieves some health information for the device
No Northbound API AvailableThis method will retrieve the health information (memory, cpu utilization) of the device from Automation Gateway
-
getDeviceInfo
Retrieves some basic information for the device
No Northbound API AvailableThis method will retrieve the basic information (type, mac addresses) of the device from Automation Gateway
-
getDevices
Get devices from Automation Gateway
No Northbound API AvailableThis method will get all devices from Automation Gateway
-
getDevicesDetailsRaw
Get devices raw details from Automation Gateway
No Northbound API AvailableThis method will get all devices raw details from Automation Gateway
-
getDevicesFiltered
Get device(s) from Automation Gateway
No Northbound API AvailableThis method will get device(s) from Automation Gateway based on the provided criteria
-
getInventoryDevice
Get an inventory device
POST /automationgateway/getInventoryDeviceGet an inventory device
-
getInventoryDevices
Get a list of inventory devices
POST /automationgateway/getInventoryDevicesGet a list of inventory devices.
-
getInventoryGroups
Get list of groups
POST /automationgateway/getInventoryGroupsGet a list of groups.
-
getModule
Get a particular module from Automation Gateway
No Northbound API AvailableThis method will get a particular module from Automation Gateway
-
getModules
Get modules from Automation Gateway
No Northbound API AvailableThis method will get all modules from Automation Gateway
-
getNornirModule
Get a particular nornir module from Automation Gateway
No Northbound API AvailableThis method will get a particular nornir module from Automation Gateway
-
getNornirModules
Get nornir modules from Automation Gateway
No Northbound API AvailableThis method will get all nornir modules from Automation Gateway
-
getOperationalData
Retrieves operational data for the device
No Northbound API AvailableThis method will retrieve operational data of the device from Automation Gateway
-
getPlaybook
Get a particular playbook from Automation Gateway
No Northbound API AvailableThis method will get a particular playbook from Automation Gateway
-
getPlaybooks
Get playbooks from Automation Gateway
No Northbound API AvailableThis method will get all playbooks from Automation Gateway
-
getPronghorn
Get pronghorn.json for this AG.
No Northbound API AvailableGet pronghorn.json for this AG.
-
getRole
Get a particular role from Automation Gateway
No Northbound API AvailableThis method will get a particular role from Automation Gateway
-
getRoles
Get roles from Automation Gateway
No Northbound API AvailableThis method will get all roles from Automation Gateway
-
getScript
Get a particular script from Automation Gateway
No Northbound API AvailableThis method will get a particular script from Automation Gateway
-
getScripts
Get scripts from Automation Gateway
No Northbound API AvailableThis method will get all scripts from Automation Gateway
-
getTerraform
Get a particular terraform module from Automation Gateway
No Northbound API AvailableThis method will get a particular terraform module from Automation Gateway
-
getTerraforms
Get terraforms from Automation Gateway
No Northbound API AvailableThis method will get all the terraform modules from Automation Gateway
-
initTerraform
Init terraform module on Automation Gateway
No Northbound API AvailableThis method will init a module in Automation Gateway
-
isAlive
Whether the device is alive
No Northbound API AvailableThis method will retrieve the status of the device in Automation Gateway
-
loadConfig
Load raw configuration on a device
No Northbound API AvailableThis method will load the raw configuration on a device based on the configuration line(s) provided
-
netconfExecRpc
Execute proprietary operations on a device using the NETCONF protocol
POST /automationgateway/netconf/exec_rpc/executeThis method will execute proprietary operations on a device using the NETCONF protocol
-
netconfGetConfig
Retrieve configuration from a device using the NETCONF protocol
POST /automationgateway/netconf/get_config/executeThis method will retrieve configuration from a device using the NETCONF protocol
-
netconfSetConfig
Configure a device using the NETCONF protocol
POST /automationgateway/netconf/set_config/executeThis method will configure a device using the NETCONF protocol
-
netmikoSendCommandExec
IAG Native Netmiko send_command
POST /automationgateway/netmikoSendCommandExecTransactional Netmiko send_command wrapper which accepts all function parameters
-
netmikoSendConfigSet
IAG Native Netmiko send_config_set
POST /automationgateway/netmikoSendConfigSetNetmiko send_config_set wrapper which accepts all function parameters
-
planTerraform
Plan terraform module on Automation Gateway
No Northbound API AvailableThis method will plan a module in Automation Gateway
-
refreshCollections
Refresh the collections in Automation Gateway
No Northbound API AvailableThis method will refresh all collections in Automation Gateway
-
refreshInventory
Refresh the inventory in Automation Gateway
No Northbound API AvailableThis method will refresh all inventory in Automation Gateway
-
refreshModules
Refresh the modules in Automation Gateway
No Northbound API AvailableThis method will refresh all modules in Automation Gateway
-
refreshNornirModules
Refresh the nornir modules in Automation Gateway
No Northbound API AvailableThis method will refresh all nornir modules in Automation Gateway
-
refreshPlaybooks
Refresh the playbooks in Automation Gateway
No Northbound API AvailableThis method will refresh all playbooks in Automation Gateway
-
refreshRoles
Refresh the roles in Automation Gateway
No Northbound API AvailableThis method will refresh all roles in Automation Gateway
-
refreshScripts
Refresh the scripts in Automation Gateway
No Northbound API AvailableThis method will refresh all scripts in Automation Gateway
-
restoreConfig
Restore the configuration on a device
No Northbound API AvailableThis method will restore the configuration on a device to the configuration provided
-
runCollectionModule
Run a module from a collection in Automation Gateway
No Northbound API AvailableThis method will run a module from a collection in Automation Gateway
-
runCollectionRole
Run a role from a collection in Automation Gateway
No Northbound API AvailableThis method will run a role from a collection in Automation Gateway
-
runCommand
Run a command on a device
No Northbound API AvailableThis method will run the provided command on a device
-
runModule
Run a module in Automation Gateway
No Northbound API AvailableThis method will run a module in Automation Gateway
-
runNornirModule
Run a nornir module in Automation Gateway
No Northbound API AvailableThis method will run a nornir module in Automation Gateway
-
runPlaybook
Run a playbook in Automation Gateway
No Northbound API AvailableThis method will run a playbook in Automation Gateway
-
runRole
Run a role in Automation Gateway
No Northbound API AvailableThis method will run a role in Automation Gateway
-
runScript
Run a script in Automation Gateway
No Northbound API AvailableThis method will run a script in Automation Gateway
-
sendRequest
Send an HTTP/1.1 request to an inventory device.
POST /automationgateway/http_requests/request/executeSend an HTTP/1.1 request to an inventory device.
-
setConfig
Set configuration on a device
No Northbound API AvailableThis method will set the configuration on a device based on the configuration line(s) provided
-
updateDevice
Update a device in Automation Gateway
No Northbound API AvailableThis method will update a device in Automation Gateway
-
updateDeviceGroup
Update a device group in Automation Gateway
No Northbound API AvailableThis method will update a device group in Automation Gateway
-
updateInventoryDevice
Update an Inventory device
POST /automationgateway/createInventoryDeviceUpdate an Inventory device
2021.2 (latest)
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES