@ignw/intersight
v0.0.4
Published
Typescript / Javascript SDK for Cisco Intersight
Downloads
2
Readme
IGNW Intersight SDK
A Typescript / Javascript SDK for the Cisco Intersight API generated by OpenAPI generator using Intersight's publicly available open api specification.
Building
To transpile the typescript sources to javascript use:
npm install
npm run build
Installation
From npm:
npm i @ignw/intersight
From your filesystem (not recommended):
- Clone this project's repo
- CD into the repo's root folder and run
npm i
npm build
After running those commands you will have a dist folder that contains the transpiled code.
Switch back to your application code and install the package from your filesystem.
npm i /path/to/this/projects/repo
Usage (typescript)
import * as intersight from '@ignw/intersight';
const configParams: intersight.ConfigurationParameters = {
authMethods: {
http_signature: {
keyId: process.env.INTERSIGHT_API_KEY_ID,
privateKey: process.env.INTERSIGHT_SECRET_KEY,
},
},
};
const intersightConfig: intersight.Configuration = intersight.createConfiguration(
configParams,
);
const vmApi = new intersight.VirtualizationApi(intersightConfig);
vmApi.getVirtualizationVmwareVirtualMachineList().then(res => console.log(res));
Contributing
You must be a member of the IGNW organization on NPM to contribute to this project.
- If you haven't added your npm user account to the npm cli, run
npm adduser
. Otherwise, login withnpm login
. - Clone the repo for this project
- Replace the intersight-openapi-xxx.json doc with the latest version from Intersight.
- Run
npm publish --access public
to build the package and publish it to npm.