Skip to main content

ESXi

These functions can be used to pull data related to ESXi artifacts.

You can access these functions by using git to clone the API TypeScript bindings.
Then you may import them into your TypeScript code.

For example:

import { getVibs } from "./artemis-api/mod";

function main() {

  const results = getVibs();
  console.log(JSON.stringify(results));
  return results;
}

main();

getVibs(alt_path?: string) -> Vib[] | EsxiError​

Get info of installed VIBs on the system. You may provide an optional alternative glob to the directory containing VIB xml files.

ParamTypeDescription
alt_pathstringOptional glob to VIB xml files

sysLogEsxi(alt_path?: string) -> Syslog[] | EsxiError​

Get ESXi syslog entries. You may provide an optional alternative glob to the syslog.log file.

ParamTypeDescription
alt_pathstringOptional glob to syslog.log file

shellLogHistory(alt_path?: string) -> ShellHistory[] | EsxiError​

Get ESXi shell.log entries. You may provide an optional alternative glob to the shell.log file.

ParamTypeDescription
alt_pathstringOptional glob to shell.log file

esxiAccounts(alt_path?: string) -> Users[] | EsxiError​

Get ESXi user accounts. You may provide an optional alternative path to the file /etc/passwd.

| Param | Type | Description | | -------- | ------ | -----------------------=---------- | | alt_path | string | Optional path to /etc/passwd file |