Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 1.71 KB

edgeos.md

File metadata and controls

91 lines (65 loc) · 1.71 KB

EdgeOS

Overview

The resources responsible for installing and managing EdgeOS

Available Resources

  1. netField.edgeos.getEdgeos(page, limit, sortBy, sortOrder, [callback])

  2. netField.edgeos.get(edgeosId, [callback])

  3. netField.edgeos.deletegetEdgeos(edgeosId, [callback])

  4. netField.edgeos.creategetEdgeos(formData, [callback])

  5. netField.edgeos.updategetEdgeos(edgeosId, formData, [callback])

Resource Usage

getEdgeos

Get all EdgeOS
/**
 * @param {any} params 
 * @param {any} options optional
 * @param {function} callback optional
*/
netField.edgeos.getAll(params, [options], [callback])

getSingleEdgeos

Get single EdgeOS
/**
 * @param {string} edgeosId
 * @param {function} callback optional
*/
netField.edgeos.get(edgeosId, [callback])

getAvailablePlatforms

Get all available edge OS platforms
/** 
 * @param {function} callback optional
*/
netField.edgeos.getPlatforms([callback])

deleteEdgeos

Delete a EdgeOS by Id
/**
 * @param {string} edgeosId
 * @param {function} callback optional
*/
netField.edgeos.delete(edgeosId, [callback])

createEdgeos

Create a EdgeOS
/**
 * @param {object} formData
 * @param {function} callback optional
*/
netField.edgeos.create(formData, [callback])

updateEdgeos

Update a EdgeOS
/**
 * @param {string} edgeosId
 * @param {object} formData
 * @param {function} callback optional
*/
netField.edgeos.update(edgeosId, formData, [callback]);