rollouts.md

Fleet Management

Overview

The resources responsible for creating and managing fleet device rollout

Available Resources

1. netField.deployments.rollouts.getAll(organisationId, page, limit, sortBy, sortOrder, jobId, status, [callback])

2. netField.deployments.rollouts.get(rolloutId, [callback])

3. netField.deployments.rollouts.pause(rolloutId, [callback])

4. netField.deployments.rollouts.start(rolloutId, [callback])

5. netField.deployments.rollouts.rollback(rolloutId, [callback])

6. netField.deployments.rollouts.getRollbacks(rolloutId, deviceId [callback])

Resource Usage

getrollouts

Get a list of all rollouts by organisation id

/**
 * @param {number} organisationId
 * @param {number} page
 * @param {number} limit
 * @param {string} sortBy
 * @param {string} sortOrder asc, desc
 * @param {string} jobId
 * @param {string} status
 * @param {function} callback optional
 */
netField.deployments.rollouts.getAll(organisationId, page, limit, sortBy, sortOrder, jobId, status, [callback])

getrolloutbyId

Get single rollout by id

/**
 * @param {string} rolloutId
 * @param {function} callback optional
 */
netField.deployments.rollouts.get(rolloutId, [callback])

pausejobbyrolloutid

Pause execution of deployment job by rolloutId

/**
 * @param {string} rolloutId
 * @param {function} callback optional
 */
netField.deployments.rollouts.pause(rolloutId, [callback])

startjobbyrolloutid

Start execution of deployment job by rolloutId

/**
 * @param {string} rolloutId
 * @param {function} callback optional
 */
netField.deployments.rollouts.start(rolloutId, [callback])

rollbackjobbyrolloutid

Rollback deployment job by rolloutId

/**
 * @param {string} rolloutId
 * @param {function} callback optional
 */
netField.deployments.rollouts.rollback(rolloutId, [callback])

getrollbacks

Get device rollback items by rolloutId and deviceIdd

/**
 * @param {string} rolloutId
 * @param {string} deviceId
 * @param {function} callback optional
 */
netField.deployments.rollouts.getRollbacks(rolloutId, deviceId, [callback])