Skip to content

Latest commit

 

History

History
1231 lines (865 loc) · 66.7 KB

README.md

File metadata and controls

1231 lines (865 loc) · 66.7 KB

Computers

(computers)

Available Operations

createComputerById

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.createComputerById({
    id: 117029,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.CreateComputerByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.CreateComputerByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteComputerById

Deletes a computer by ID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.deleteComputerById({
    id: 361320,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteComputerByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.DeleteComputerByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteComputerByMacAddress

Deletes a computer by MAC address

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.deleteComputerByMacAddress({
    macaddress: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteComputerByMacAddressRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.DeleteComputerByMacAddressResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteComputerByName

Deletes a computer by name

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.deleteComputerByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteComputerByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.DeleteComputerByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteComputerBySerialNumber

Deletes a computer by serial number

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.deleteComputerBySerialNumber({
    serialnumber: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteComputerBySerialNumberRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.DeleteComputerBySerialNumberResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteComputerByUDID

Deletes a computer by UDID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.deleteComputerByUDID({
    udid: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteComputerByUDIDRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.DeleteComputerByUDIDResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputers

Finds all computers

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputers();

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersBasic

Finds basic information for all computers

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersBasic();

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersBasicResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersById

Finds computers by ID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersById({
    id: 962919,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByIdSubset

Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Location)

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByIdSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByIdSubset({
    id: 130265,
    subset: FindComputersByIdSubsetPathParamSubset.Peripherals,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByIdSubsetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByIdSubsetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByMacAddress

Finds computers by MAC address

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByMacAddress({
    macaddress: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByMacAddressRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByMacAddressResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByMacAddressSubset

Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByMacAddressSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByMacAddressSubset({
    macaddress: "<value>",
    subset: FindComputersByMacAddressSubsetPathParamSubset.ConfigurationProfiles,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByMacAddressSubsetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByMacAddressSubsetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByName

Finds the first computer with the given name

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByNameSubset

Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByNameSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByNameSubset({
    name: "<value>",
    subset: FindComputersByNameSubsetPathParamSubset.Location,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByNameSubsetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByNameSubsetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersBySerialNumber

Finds computers by serial number

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersBySerialNumber({
    serialnumber: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersBySerialNumberRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersBySerialNumberResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersBySerialNumberSubset

Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersBySerialNumberSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersBySerialNumberSubset({
    serialnumber: "<value>",
    subset: FindComputersBySerialNumberSubsetPathParamSubset.Software,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersBySerialNumberSubsetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersBySerialNumberSubsetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByUDID

Finds computers by UDID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByUDID({
    udid: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByUDIDRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByUDIDResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findComputersByUDIDSubset

Subset values can also be appended using an ampersand to return multiple subsets (e.g. /subsets/General&Hardware)

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";
import { FindComputersByUDIDSubsetPathParamSubset } from "jamf-classic-sdk-nodejs/dist/sdk/models/operations";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.findComputersByUDIDSubset({
    subset: FindComputersByUDIDSubsetPathParamSubset.ExtensionAttributes,
    udid: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindComputersByUDIDSubsetRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FindComputersByUDIDSubsetResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

flushComputerExtenstionAttributeData

Deletes data collected by an extension attribute

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.flushComputerExtenstionAttributeData({
    id: "<id>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FlushComputerExtenstionAttributeDataRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.FlushComputerExtenstionAttributeDataResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

matchComputers

Match performs the same function as a simple search in the GUI.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.matchComputers({
    match: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.MatchComputersRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.MatchComputersResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

matchComputersNames

Searches for computers that match the provided name parameter

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.matchComputersNames({
    matchname: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.MatchComputersNamesRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.MatchComputersNamesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateComputerById

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.updateComputerById({
    id: 576492,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateComputerByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.UpdateComputerByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateComputerByMacAddress

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.updateComputerByMacAddress({
    macaddress: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateComputerByMacAddressRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.UpdateComputerByMacAddressResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateComputerByName

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.updateComputerByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateComputerByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.UpdateComputerByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateComputerBySerialNumber

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.updateComputerBySerialNumber({
    serialnumber: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateComputerBySerialNumberRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.UpdateComputerBySerialNumberResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateComputerByUDID

Certificates and mdm_capable are ignored.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.computers.updateComputerByUDID({
    udid: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateComputerByUDIDRequest ✔️ The request object to use for the request.
config AxiosRequestConfig Available config options for making requests.

Response

Promise<operations.UpdateComputerByUDIDResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /