node-cisco-axl

Cisco Unified Communications Manager has been the gold standard in enterprise unified communication for years, but using it's Administrative XML or AXL toolkit can be a beast. It changes frequently, uses SOAP rather than REST, and returns XML not JSON.

The goal of this project is to make it easier for people to use AXL, focusing on top use cases, not all functions!

Cisco Developer Docs for AXL

Installation

npm install node-cisco-axl

Usage

Require AXL, add options, and pass options as new object:

var AXL = require('node-cisco-axl');

var axlOptions = {
    host: process.env.CUCM,
    user: process.env.AXLUSER,
    pass: process.env.AXLPASS,
    version: process.env.AXLVERSION
}

const axl = new AXL(axlOptions);

axl.listTransPattern('9109200040')
    .then(uuid => {
        console.log('uuid =', uuid);
    });
});

1.0.1 update: Now parses and returns JSON object instead of XML!

Methods

• AXL
  • new AXL(options)
  • .listRoutePlan(pattern) ⇒ Promise.<Response>
  • .listTransPattern(pattern) ⇒ Promise.<Response>
  • .listLdapDirectory() ⇒ Promise.<Response>
  • .getPhoneByUUID(uuid) ⇒ Promise.<Response>
  • .getPhoneByName(name) ⇒ Promise.<Response>
  • .getLine(pattern) ⇒ Promise.<Response>
  • .getTransPattern(uuid) ⇒ Promise.<Response>
  • .updatePhoneByName(name) ⇒ Promise.<Response>
  • .updatePhoneByUUID(uuid) ⇒ Promise.<Response>
  • .updateLineByNumber(number) ⇒ Promise.<Response>
  • .updateLineByUUID(number) ⇒ Promise.<Response>
  • .doLdapSync(uuid) ⇒ Promise.<Response>
  • .updateUserPin(user, pin) ⇒ Promise.<Response>

axL.listRoutePlan(pattern) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | pattern | any |

axL.listTransPattern(pattern) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | pattern | any |

axL.listLdapDirectory() ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

axL.getPhoneByUUID(uuid) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | uuid | any |

axL.getPhoneByName(name) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | name | any |

axL.getLine(pattern) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | pattern | any |

axL.getTransPattern(uuid) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | uuid | any |

axL.updatePhoneByName(name) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | name | any |

axL.updatePhoneByUUID(uuid) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | uuid | any |

axL.updateLineByNumber(number) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | number | any |

axL.updateLineByUUID(number) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | number | any |

axL.doLdapSync(uuid) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | uuid | any |

axL.updateUserPin(user, pin) ⇒ Promise.<Response>

Kind: instance method of AXL
Returns: Promise.<Response> - Response promise

| Param | Type | | --- | --- | | user | any | | pin | any |

Getting support

You can find me on Cisco Spark: [email protected]

But if you know you really found a bug, feel free to open an issue instead.

node-cisco-axl