Methods

On this page:

Device Broker

Deprecated Device Broker Methods

The following methods were deprecated in the Device Broker due to their NSO specificity and replaced with a direct adapter method, where indicated.

Method Description Deprecation Release Scheduled Removal Release Replacement
aclImport Imports an ACL list into IAP. 2018.3 2019.1 Adapters built with adapter-template and aclImport.
addDeviceGroup Adds a device group to NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
addDeviceToGroup Adds a device to a device group in NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
addToAuthGroup Adds a device to an NSO authgroup. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
applyTemplate Applies a golden config template to a device. 2018.3 2019.1 adapter-nso
applyTemplates
applyTemplates Apply multiple device templates. 2018.3 2019.1 adapter-nso
applyTemplates
applyVariableTemplate Applies a variable template to a device. 2018.3 2019.1 adapter-nso
applyTemplates
connectDevice Checks a device connection from Pronghorn to a device through NSO. 2018.3 2019.1 Device Broker
isAlive
checkSync Checks to see if a device is in-sync. 2018.3 2019.1 adapter-nso
checkSync
checkSyncDevices Checks to see if an array of devices are in-sync. 2018.3 2019.1 adapter-nso
checkSyncDevices
deleteDeviceGroup Deletes a device group from NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
dryRun Dry runs the setting config on a device. 2018.3 2019.1 adapter-nso
doDryRun
dryRunVariableTemplate Dry run for applying a variable template to a device. 2018.3 2019.1 adapter-nso
applyTemplates
getAuthGroups Gets all the authgroups in NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
getDeviceGroups Gets the device groups. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
getDeviceGroupsForDevices Gets the device groups for all the devices. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
getDevices Gets a list of devices from all SB systems. 2018.3 2019.1 device broker
getDevicesFiltered
getNEDs Gets the available NEDs that are installed on the NSO that is currently in use. 2018.3 2019.1 adapter-nso
getNEDS
getOutOfSyncConfig Gets the out of sync config for a specific device. 2018.3 2019.1 adapter-nso
getOutOfSyncConfig
getTemplates Gets the available templates for devices. 2018.3 2019.1 adapter-nso
getTemplates
liveStatus Attempts to send data directly to a device. 2018.3 2019.1 adapter-nso
liveStatus
liveStatusScanHosts Will search all hosts that recognize the device. 2018.3 2019.1 adapter-nso
liveStatus
locateDeviceGroups Locates a device group in NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
passThru Passes a command to a device through NSO. 2018.3 2019.1 adapter-nso
passThru
pingDevice Pings a device. 2018.3 2019.1 adapter-nso
pingDevice
provision Provisions a service or device through NSO. 2018.3 2019.1 adapter-nso
doProvision
query Makes a query call to NSO. 2018.3 2019.1 adapter-nso
doQuery
removeDeviceFromGroup Removes a device from a device group in NSO. 2018.3 2019.1 Itential no longer supports NSO device groups and auth groups as broker-able constructs. Use adapter tasks instead.
RESTAction Makes a REST action call to NSO. 2018.3 2019.1 adapter-nso
doRESTAction
restoreDevice Restore the given configuration to a device. 2019.1 2020.3 restoreConfig
RESTQuery Makes a REST query call to NSO. 2018.3 2019.1 adapter-nso
doRestQuery
runAction Run an action against a device. 2018.3 2019.1 adapter-nso
runAction
syncFrom Syncs the config in NSO to the device config. 2018.3 2019.1 adapter-nso
syncFrom
syncFromDevices Syncs an array of devices. 2018.3 2019.1 adapter-nso
syncFrom
syncTo Syncs the device config to NSO. 2018.3 2019.1 adapter-nso
syncTo
syncToDevices Syncs an array of devices. 2018.3 2019.1 adapter-nso
syncTo
turnUpDevice Turns up an existing device and adds it to NSO. 2018.3 2019.1 adapter-nso
turnUpDevice
updateDeviceSetting Updates an NSO device setting. 2018.3 2019.1 adapter-nso
addDevice with settings.
verifyConfig Verifies a config for a specific NED/Device. 2018.3 2019.1 adapter-nso
verifyConfig