@notthatjesus/cisco-unified-communications-manager
v2026.04.07.6
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
Labels
ciscocucmvoiptelephonyaxl
Contents
Install
$ swamp extension pull @notthatjesus/cisco-unified-communications-manager@notthatjesus/cisco-unified-communications-manager/phonev2026.04.07.3phones.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| host | string | CUCM hostname or IP address |
| username | string | AXL username |
| password | string | AXL password |
listPhoneList phones from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.
| Argument | Type | Description |
|---|---|---|
| name? | string | |
| description? | string | |
| protocol? | string | |
| callingSearchSpaceName? | string | |
| devicePoolName? | string | |
| securityProfileName? | string | |
| skip? | number | Pagination offset |
| first? | number | Max records to return |
getPhoneGet full details of a single phone by name or UUID. Stores result keyed by phone name.
| Argument | Type | Description |
|---|---|---|
| name? | string | Device name (e.g. SEP000C30F01E48) |
| uuid? | string | Phone UUID |
addPhoneAdd a new phone to CUCM. Stores the created phone record afterwards.
| Argument | Type | Description |
|---|---|---|
| name | string | Device name (e.g. SEP001122334455) |
| product | string | Product type (e.g. 'Cisco 8861', 'Cisco IP Communicator') |
| class | string | Device class — almost always 'Phone' |
| protocol | string | Protocol: 'SIP' or 'SCCP' |
| protocolSide | string | Protocol side — almost always 'User' |
| devicePoolName | string | Device pool name |
| commonPhoneConfigName | string | |
| locationName | string | |
| useTrustedRelayPoint | string | |
| phoneTemplateName | string | Phone button template name |
| builtInBridgeStatus | string | |
| packetCaptureMode | string | |
| description? | string | |
| callingSearchSpaceName? | string | |
| commonDeviceConfigName? | string | |
| securityProfileName? | string | |
| sipProfileName? | string | |
| softkeyTemplateName? | string | |
| ownerUserName? | string | |
| enableExtensionMobility | boolean | |
| allowCtiControlFlag | boolean | |
| lines? | array | Lines (DNs) to assign to the phone |
updatePhoneUpdate a phone in CUCM AXL. Identify by name or uuid. Only provided fields are updated. Refreshes stored phone record afterwards.
| Argument | Type | Description |
|---|---|---|
| name? | string | Current device name |
| uuid? | string | Phone UUID |
| newName? | string | Rename the device |
| description? | string | Device description |
| devicePoolName? | string | Device pool name |
| callingSearchSpaceName? | string | CSS name (null to clear) |
| locationName? | string | Location name |
| commonDeviceConfigName? | string | Common device config name (null to clear) |
| commonPhoneConfigName? | string | Common phone config name |
| securityProfileName? | string | Security profile name |
| sipProfileName? | string | SIP profile name (null to clear) |
| phoneTemplateName? | string | Phone button template name |
| softkeyTemplateName? | string | Softkey template name (null to clear) |
| ownerUserName? | string | Owner user ID (null to clear) |
| enableExtensionMobility? | boolean | Enable Extension Mobility |
| allowCtiControlFlag? | boolean | Allow CTI control |
| isActive? | boolean | Whether the device consumes a license |
removePhoneRemove a phone from CUCM by name or UUID.
| Argument | Type | Description |
|---|---|---|
| name? | string | Device name (e.g. SEP001122334455) |
| uuid? | string | 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 | Description |
|---|---|---|
| host | string | CUCM hostname or IP address |
| username | string | AXL username |
| password | string | AXL password |
listLineList directory numbers (lines) from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.
| Argument | Type | Description |
|---|---|---|
| pattern? | string | |
| description? | string | |
| usage? | string | |
| routePartitionName? | string | |
| skip? | number | Pagination offset |
| first? | number | Max records to return |
getLineGet full details of a single directory number by pattern+partition or UUID. Stores result keyed by pattern[@partition].
| Argument | Type | Description |
|---|---|---|
| pattern? | string | DN pattern (e.g. '1001') |
| uuid? | string | Line UUID |
addLineAdd a new directory number (line) to CUCM.
| Argument | Type | Description |
|---|---|---|
| pattern | string | DN pattern (e.g. '1001') |
| description? | string | Description of this DN |
| alertingName? | string | Alerting name (caller ID) |
| asciiAlertingName? | string | ASCII alerting name |
| presenceGroupName? | string | Presence group |
| shareLineAppearanceCssName? | string | Shared line CSS |
| voiceMailProfileName? | string | Voice mail profile |
| active? | boolean | Whether the line is active |
updateLineUpdate a directory number in CUCM AXL. Identify by pattern+partition or UUID. Only provided fields are updated. Refreshes stored line record afterwards.
| Argument | Type | Description |
|---|---|---|
| pattern? | string | Current DN pattern |
| uuid? | string | Line UUID |
| newPattern? | string | New DN pattern (rename) |
| description? | string | |
| alertingName? | string | |
| asciiAlertingName? | string | |
| presenceGroupName? | string | |
| shareLineAppearanceCssName? | string | |
| voiceMailProfileName? | string | |
| autoAnswer? | string | |
| active? | boolean |
removeLineRemove a directory number from CUCM by pattern+partition or UUID.
| Argument | Type | Description |
|---|---|---|
| pattern? | string | DN pattern (e.g. '1001') |
| uuid? | string | 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 | Description |
|---|---|---|
| host | string | CUCM hostname or IP address |
| username | string | AXL username |
| password | string | AXL password |
listUserList end users from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.
| Argument | Type | Description |
|---|---|---|
| firstName? | string | |
| lastName? | string | |
| userid? | string | |
| department? | string | |
| skip? | number | Pagination offset |
| first? | number | Max records to return |
getUserGet full details of a single end user by userid or UUID. Stores result keyed by userid.
| Argument | Type | Description |
|---|---|---|
| userid? | string | User ID (login name) |
| uuid? | string | User UUID |
addUserAdd a new end user to CUCM.
| Argument | Type | Description |
|---|---|---|
| userid | string | Unique user ID (login name) |
| lastName | string | Last name |
| presenceGroupName | string | Presence group name |
| firstName? | string | |
| middleName? | string | |
| displayName? | string | |
| mailid? | string | Email address |
| department? | string | |
| manager? | string | |
| password? | string | Web application password |
| pin? | string | Phone PIN |
| telephoneNumber? | string | Phone number shown in directory |
| title? | string | |
| mobileNumber? | string | |
| homeNumber? | string | |
| directoryUri? | string | URI (user@domain format) |
| enableCti | boolean | |
| enableMobility | boolean | |
| enableMobileVoiceAccess | boolean | |
| imAndPresenceEnable | boolean | |
| homeCluster | boolean | |
| pattern | string | |
| routePartitionName? | string |
updateUserUpdate an end user in CUCM AXL. Identify by userid or UUID. Only provided fields are updated. Refreshes stored user record afterwards.
| Argument | Type | Description |
|---|---|---|
| userid? | string | Current user ID |
| uuid? | string | User UUID |
| newUserid? | string | Rename the user ID |
| 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 | Full replacement list of associated device names |
| primaryExtension? | object |
removeUserRemove an end user from CUCM by userid or UUID.
| Argument | Type | Description |
|---|---|---|
| userid? | string | User ID |
| uuid? | string | 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 | Description |
|---|---|---|
| host | string | CUCM hostname or IP address |
| username | string | AXL username |
| password | string | AXL password |
listDeviceProfileList device profiles from CUCM AXL. At least one searchCriteria field is required; use '%' for wildcard.
| Argument | Type | Description |
|---|---|---|
| name? | string | |
| description? | string | |
| skip? | number | |
| first? | number |
getDeviceProfileGet full details of a device profile by name or UUID.
| Argument | Type | Description |
|---|---|---|
| name? | string | Device profile name |
| uuid? | string | Device profile UUID |
addDeviceProfileAdd a new device profile to CUCM.
| Argument | Type | Description |
|---|---|---|
| name | string | Device profile name |
| product | string | Product type (e.g. 'Cisco 8861') |
| class | string | Device class — almost always 'Device Profile' |
| protocol | string | Protocol: 'SIP' or 'SCCP' |
| protocolSide | string | |
| phoneTemplateName | string | Phone button template name |
| description? | string | |
| softkeyTemplateName? | string | |
| userLocale? | string | |
| lines? | array | Lines to assign to the profile |
updateDeviceProfileUpdate a device profile in CUCM. Only provided fields are updated.
| Argument | Type | Description |
|---|---|---|
| name? | string | Current device profile name |
| uuid? | string | Device profile UUID |
| newName? | string | Rename the profile |
| description? | string | |
| phoneTemplateName? | string | |
| softkeyTemplateName? | string | |
| userLocale? | string |
removeDeviceProfileRemove a device profile from CUCM by name or UUID.
| Argument | Type | Description |
|---|---|---|
| name? | string | Device profile name |
| uuid? | string | Device profile UUID |
Resources
deviceProfiles(infinite)— Device profiles returned by listDeviceProfile
deviceProfile(infinite)— Full device profile detail returned by getDeviceProfile, keyed by name
2026.04.07.5691.1 KBApr 7, 2026
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
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
ciscocucmvoiptelephonyaxl
2026.04.07.4691.0 KBApr 7, 2026
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
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
ciscocucmvoiptelephonyaxl
2026.04.07.3691.1 KBApr 7, 2026
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
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
ciscocucmvoiptelephonyaxl
2026.04.07.2691.0 KBApr 7, 2026
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
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
ciscocucmvoiptelephonyaxl
2026.04.07.1691.0 KBApr 7, 2026
Cisco Unified Communications Manager (CUCM) automation via the AXL SOAP API. Manage phones, directory numbers, end users, and device profiles.
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
ciscocucmvoiptelephonyaxl