Cisco Unified Communications Manager

@notthatjesus/cisco-unified-communications-managerv2026.04.07.6· 1mo agoMODELS

01README

Cisco Unified Communications Manager (CUCM) automation via the AXL SOAP API. Manage phones, directory numbers, end users, and device profiles. https://github.com/notthatjesus/swamp-cucm

02Models4

@notthatjesus/cisco-unified-communications-manager/phonev2026.04.07.3phones.ts

Global Arguments

Argument	Type	Required	Description
host	string	yes	CUCM hostname or IP address
username	string	yes	AXL username
password	string	yes	AXL password

fn listPhone(name?: string, description?: string, protocol?: string, callingSearchSpaceName?: string, devicePoolName?: string, securityProfileName?: string, skip?: number, first?: number)

List phones from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.

Argument	Type	Required	Description
name?	string	no
description?	string	no
protocol?	string	no
callingSearchSpaceName?	string	no
devicePoolName?	string	no
securityProfileName?	string	no
skip?	number	no	Pagination offset
first?	number	no	Max records to return

fn getPhone(name?: string, uuid?: string)

Get full details of a single phone by name or UUID. Stores result keyed by phone name.

Argument	Type	Required	Description
name?	string	no	Device name (e.g. SEP000C30F01E48)
uuid?	string	no	Phone UUID

fn addPhone(name: string, product: string, class: string, protocol: string, protocolSide: string, devicePoolName: string, commonPhoneConfigName: string, locationName: string, useTrustedRelayPoint: string, phoneTemplateName: string, builtInBridgeStatus: string, packetCaptureMode: string, description?: string, callingSearchSpaceName?: string, commonDeviceConfigName?: string, securityProfileName?: string, sipProfileName?: string, softkeyTemplateName?: string, ownerUserName?: string, enableExtensionMobility: boolean, allowCtiControlFlag: boolean, lines?: array)

Add a new phone to CUCM. Stores the created phone record afterwards.

Argument	Type	Required	Description
name	string	yes	Device name (e.g. SEP001122334455)
product	string	yes	Product type (e.g. 'Cisco 8861', 'Cisco IP Communicator')
class	string	yes	Device class — almost always 'Phone'
protocol	string	yes	Protocol: 'SIP' or 'SCCP'
protocolSide	string	yes	Protocol side — almost always 'User'
devicePoolName	string	yes	Device pool name
commonPhoneConfigName	string	yes
locationName	string	yes
useTrustedRelayPoint	string	yes
phoneTemplateName	string	yes	Phone button template name
builtInBridgeStatus	string	yes
packetCaptureMode	string	yes
description?	string	no
callingSearchSpaceName?	string	no
commonDeviceConfigName?	string	no
securityProfileName?	string	no
sipProfileName?	string	no
softkeyTemplateName?	string	no
ownerUserName?	string	no
enableExtensionMobility	boolean	yes
allowCtiControlFlag	boolean	yes
lines?	array	no	Lines (DNs) to assign to the phone

fn updatePhone(name?: string, uuid?: string, newName?: string, description?: string, devicePoolName?: string, callingSearchSpaceName?: string, locationName?: string, commonDeviceConfigName?: string, commonPhoneConfigName?: string, securityProfileName?: string, sipProfileName?: string, phoneTemplateName?: string, softkeyTemplateName?: string, ownerUserName?: string, enableExtensionMobility?: boolean, allowCtiControlFlag?: boolean, isActive?: boolean)

Update a phone in CUCM AXL. Identify by name or uuid. Only provided fields are updated. Refreshes stored phone record afterwards.

Argument	Type	Required	Description
name?	string	no	Current device name
uuid?	string	no	Phone UUID
newName?	string	no	Rename the device
description?	string	no	Device description
devicePoolName?	string	no	Device pool name
callingSearchSpaceName?	string	no	CSS name (null to clear)
locationName?	string	no	Location name
commonDeviceConfigName?	string	no	Common device config name (null to clear)
commonPhoneConfigName?	string	no	Common phone config name
securityProfileName?	string	no	Security profile name
sipProfileName?	string	no	SIP profile name (null to clear)
phoneTemplateName?	string	no	Phone button template name
softkeyTemplateName?	string	no	Softkey template name (null to clear)
ownerUserName?	string	no	Owner user ID (null to clear)
enableExtensionMobility?	boolean	no	Enable Extension Mobility
allowCtiControlFlag?	boolean	no	Allow CTI control
isActive?	boolean	no	Whether the device consumes a license

fn removePhone(name?: string, uuid?: string)

Remove a phone from CUCM by name or UUID.

Argument	Type	Required	Description
name?	string	no	Device name (e.g. SEP001122334455)
uuid?	string	no	Phone UUID

Resources

phones(infinite)— Phone devices returned by listPhone

phone(infinite)— Full phone detail returned by getPhone, keyed by phone name

@notthatjesus/cisco-unified-communications-manager/linev2026.04.07.4lines.ts

Global Arguments

Argument	Type	Required	Description
host	string	yes	CUCM hostname or IP address
username	string	yes	AXL username
password	string	yes	AXL password

fn listLine(pattern?: string, description?: string, usage?: string, routePartitionName?: string, skip?: number, first?: number)

List directory numbers (lines) from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.

Argument	Type	Required	Description
pattern?	string	no
description?	string	no
usage?	string	no
routePartitionName?	string	no
skip?	number	no	Pagination offset
first?	number	no	Max records to return

fn getLine(pattern?: string, uuid?: string)

Get full details of a single directory number by pattern+partition or UUID. Stores result keyed by pattern[@partition].

Argument	Type	Required	Description
pattern?	string	no	DN pattern (e.g. '1001')
uuid?	string	no	Line UUID

fn addLine(pattern: string, description?: string, alertingName?: string, asciiAlertingName?: string, presenceGroupName?: string, shareLineAppearanceCssName?: string, voiceMailProfileName?: string, active?: boolean)

Add a new directory number (line) to CUCM.

Argument	Type	Required	Description
pattern	string	yes	DN pattern (e.g. '1001')
description?	string	no	Description of this DN
alertingName?	string	no	Alerting name (caller ID)
asciiAlertingName?	string	no	ASCII alerting name
presenceGroupName?	string	no	Presence group
shareLineAppearanceCssName?	string	no	Shared line CSS
voiceMailProfileName?	string	no	Voice mail profile
active?	boolean	no	Whether the line is active

fn updateLine(pattern?: string, uuid?: string, newPattern?: string, description?: string, alertingName?: string, asciiAlertingName?: string, presenceGroupName?: string, shareLineAppearanceCssName?: string, voiceMailProfileName?: string, autoAnswer?: string, active?: boolean)

Update a directory number in CUCM AXL. Identify by pattern+partition or UUID. Only provided fields are updated. Refreshes stored line record afterwards.

Argument	Type	Required	Description
pattern?	string	no	Current DN pattern
uuid?	string	no	Line UUID
newPattern?	string	no	New DN pattern (rename)
description?	string	no
alertingName?	string	no
asciiAlertingName?	string	no
presenceGroupName?	string	no
shareLineAppearanceCssName?	string	no
voiceMailProfileName?	string	no
autoAnswer?	string	no
active?	boolean	no

fn removeLine(pattern?: string, uuid?: string)

Remove a directory number from CUCM by pattern+partition or UUID.

Argument	Type	Required	Description
pattern?	string	no	DN pattern (e.g. '1001')
uuid?	string	no	Line UUID

Resources

lines(infinite)— Directory numbers returned by listLine

line(infinite)— Full line detail returned by getLine, keyed by pattern[@partition]

@notthatjesus/cisco-unified-communications-manager/userv2026.04.07.5users.ts

Global Arguments

Argument	Type	Required	Description
host	string	yes	CUCM hostname or IP address
username	string	yes	AXL username
password	string	yes	AXL password

fn listUser(firstName?: string, lastName?: string, userid?: string, department?: string, skip?: number, first?: number)

List end users from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.

Argument	Type	Required	Description
firstName?	string	no
lastName?	string	no
userid?	string	no
department?	string	no
skip?	number	no	Pagination offset
first?	number	no	Max records to return

fn getUser(userid?: string, uuid?: string)

Get full details of a single end user by userid or UUID. Stores result keyed by userid.

Argument	Type	Required	Description
userid?	string	no	User ID (login name)
uuid?	string	no	User UUID

fn addUser(userid: string, lastName: string, presenceGroupName: string, firstName?: string, middleName?: string, displayName?: string, mailid?: string, department?: string, manager?: string, password?: string, pin?: string, telephoneNumber?: string, title?: string, mobileNumber?: string, homeNumber?: string, directoryUri?: string, enableCti: boolean, enableMobility: boolean, enableMobileVoiceAccess: boolean, imAndPresenceEnable: boolean, homeCluster: boolean, pattern: string, routePartitionName?: string)

Add a new end user to CUCM.

Argument	Type	Required	Description
userid	string	yes	Unique user ID (login name)
lastName	string	yes	Last name
presenceGroupName	string	yes	Presence group name
firstName?	string	no
middleName?	string	no
displayName?	string	no
mailid?	string	no	Email address
department?	string	no
manager?	string	no
password?	string	no	Web application password
pin?	string	no	Phone PIN
telephoneNumber?	string	no	Phone number shown in directory
title?	string	no
mobileNumber?	string	no
homeNumber?	string	no
directoryUri?	string	no	URI (user@domain format)
enableCti	boolean	yes
enableMobility	boolean	yes
enableMobileVoiceAccess	boolean	yes
imAndPresenceEnable	boolean	yes
homeCluster	boolean	yes
pattern	string	yes
routePartitionName?	string	no

fn updateUser(userid?: string, uuid?: string, newUserid?: string, firstName?: string, middleName?: string, lastName?: string, displayName?: string, mailid?: string, department?: string, manager?: string, password?: string, pin?: string, telephoneNumber?: string, title?: string, mobileNumber?: string, homeNumber?: string, directoryUri?: string, presenceGroupName?: string, enableCti?: boolean, enableMobility?: boolean, enableMobileVoiceAccess?: boolean, imAndPresenceEnable?: boolean, homeCluster?: boolean, associatedDevices?: array, primaryExtension?: object)

Update an end user in CUCM AXL. Identify by userid or UUID. Only provided fields are updated. Refreshes stored user record afterwards.

Argument	Type	Required	Description
userid?	string	no	Current user ID
uuid?	string	no	User UUID
newUserid?	string	no	Rename the user ID
firstName?	string	no
middleName?	string	no
lastName?	string	no
displayName?	string	no
mailid?	string	no
department?	string	no
manager?	string	no
password?	string	no
pin?	string	no
telephoneNumber?	string	no
title?	string	no
mobileNumber?	string	no
homeNumber?	string	no
directoryUri?	string	no
presenceGroupName?	string	no
enableCti?	boolean	no
enableMobility?	boolean	no
enableMobileVoiceAccess?	boolean	no
imAndPresenceEnable?	boolean	no
homeCluster?	boolean	no
associatedDevices?	array	no	Full replacement list of associated device names
primaryExtension?	object	no

fn removeUser(userid?: string, uuid?: string)

Remove an end user from CUCM by userid or UUID.

Argument	Type	Required	Description
userid?	string	no	User ID
uuid?	string	no	User UUID

Resources

users(infinite)— End users returned by listUser

user(infinite)— Full user detail returned by getUser, keyed by userid

@notthatjesus/cisco-unified-communications-manager/device-profilev2026.04.07.3device_profiles.ts

Global Arguments

Argument	Type	Required	Description
host	string	yes	CUCM hostname or IP address
username	string	yes	AXL username
password	string	yes	AXL password

fn listDeviceProfile(name?: string, description?: string, skip?: number, first?: number)

List device profiles from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.

Argument	Type	Required
name?	string	no
description?	string	no
skip?	number	no
first?	number	no

fn getDeviceProfile(name?: string, uuid?: string)

Get full details of a device profile by name or UUID.

Argument	Type	Required	Description
name?	string	no	Device profile name
uuid?	string	no	Device profile UUID

fn addDeviceProfile(name: string, product: string, class: string, protocol: string, protocolSide: string, phoneTemplateName: string, description?: string, softkeyTemplateName?: string, userLocale?: string, lines?: array)

Add a new device profile to CUCM.

Argument	Type	Required	Description
name	string	yes	Device profile name
product	string	yes	Product type (e.g. 'Cisco 8861')
class	string	yes	Device class — almost always 'Device Profile'
protocol	string	yes	Protocol: 'SIP' or 'SCCP'
protocolSide	string	yes
phoneTemplateName	string	yes	Phone button template name
description?	string	no
softkeyTemplateName?	string	no
userLocale?	string	no
lines?	array	no	Lines to assign to the profile

fn updateDeviceProfile(name?: string, uuid?: string, newName?: string, description?: string, phoneTemplateName?: string, softkeyTemplateName?: string, userLocale?: string)

Update a device profile in CUCM. Only provided fields are updated.

Argument	Type	Required	Description
name?	string	no	Current device profile name
uuid?	string	no	Device profile UUID
newName?	string	no	Rename the profile
description?	string	no
phoneTemplateName?	string	no
softkeyTemplateName?	string	no
userLocale?	string	no

fn removeDeviceProfile(name?: string, uuid?: string)

Remove a device profile from CUCM by name or UUID.

Argument	Type	Required	Description
name?	string	no	Device profile name
uuid?	string	no	Device profile UUID

Resources

deviceProfiles(infinite)— Device profiles returned by listDeviceProfile

deviceProfile(infinite)— Full device profile detail returned by getDeviceProfile, keyed by name

03Previous Versions5

2026.04.07.5Apr 7, 2026

2026.04.07.4Apr 7, 2026

2026.04.07.3Apr 7, 2026

2026.04.07.2Apr 7, 2026

2026.04.07.1Apr 7, 2026

04Stats

Downloads

Archive size

691.2 KB

Not yet scored.

A score will be generated the next time this extension is published. The owner can also trigger scoring manually.

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#cisco #cucm #voip #telephony #axl