Skip to main content
Ctrl+K

VOSS Automate 25.3

  • Back to Help Home
  • Release Notes for Automate 25.3
  • Compatibility Matrix
  • Core Feature Guide
    • What’s New
    • Introduction
      • Welcome to Automate
      • Manage your Automate product license
      • Log in
      • Role-based dashboards and menus
      • Guide to the Admin Portal user interface
      • Manage items
      • Working with lists
      • Use the Action search to navigate Automate
      • Search in Automate
      • Searchable fields
      • Case-insensitive search fields
      • Wingman
    • Quick Start Guides
      • Customer Onboarding Quick Start Guide (Multiple Vendors)
      • Microsoft Quick Start Guide for Automate
    • Hierarchy Management
      • Introduction to hierarchies
      • Navigate the hierarchy
      • View the Hierarchy
      • Add a provider
      • Resellers
      • Customers
      • Intermediate node
      • Sites
      • Site Defaults Doc templates
      • Site defaults
      • Delete a hierarchy
      • Delete issues and purges
      • Localization language
    • Role Based Access
      • Introduction to role-based access control
      • Clone a role
      • Delete unused roles
      • Introduction to user management
      • View users
      • Add admin user
      • Update a user
      • Manage local administrators and operators
      • View and update LDAP authentication users
      • Cisco Webex App users
      • Role Management
      • Authorized Admin Hierarchy Roles
      • Introduction to Automate dashboards
      • Manage dashboards and widgets
      • Chart widgets
      • Counter widgets
      • Links widgets
      • Table widgets
      • Text widgets
      • Dashboards for a Business Admin role
      • Dashboard management reference
      • Dashboard Exports
      • Schedule dashboard export report
      • Menu layouts
      • Fixed and configurable filters in menus
      • Field display policies
      • Introduction to themes
      • Manage themes
      • Theme element color references for the Admin portal
      • Setting the default theme
      • Introduction to access profiles
      • Access profile permissions and operations
      • Menu diff tool
      • Menu Merge tool
      • Credential policies
      • Assign a credential policy to a user
      • Assign a credential policy to an administrator
      • Customized credential policy
      • Credential policies
      • Privacy policy menu items
      • Manage privacy policy menu items
      • Support for privacy and security notices
      • Automate cookie policy
      • Login notification banner
      • Single Sign On (SSO) Overview
      • Configure Self-service SSO SP settings
      • SAML Elements in Assertions
      • Configure SSO IdP
      • Update the metadata file on a SSO IdP entry
      • File management
      • Upload SSO IdP metadata
    • App Integration and Detailed Settings
      • Microsoft Quick Start Guide for Automate
      • Introduction to Microsoft UC integration
      • Microsoft UC Application Setup
      • Run PowerShell proxy server setup script
      • Configure Automate for Microsoft services
      • Shared central app registration
      • Upload a certificate to use for app registration
      • Test the PowerShell proxy connection to the tenant
      • Sync in Azure users
      • Sync Microsoft users to sites
      • Create MS Teams service account on Microsoft cloud
      • Microsoft tenant setup
      • External access for MS Teams
      • Microsoft Licenses
      • Microsoft license management and alerting
      • Manage certificates for SSO
      • Generate a certificate for application registration
      • Network device lists (NDLs)
      • Teams
      • Groups
      • Manage group membership
      • Introduction to Microsoft Teams emergency management
      • MS Teams emergency location networks
      • MS Teams emergency locations
      • Introduction to Microsoft Teams policies
      • Introduction to Microsoft Teams dial plan management
      • Microsoft dial plan models
      • Holidays
      • Introduction to Microsoft Teams policies
      • MS Teams templates
      • Introduction to Microsoft Teams dial plan management
      • Configure Microsoft tenant dialplan
      • MS Numbers
      • MS Blocked Calling Numbers
      • Microsoft license management and alerting
      • Introduction to Cisco Webex App
      • Webex App licenses
      • Webex bulk actions
      • Bulk update Webex App users
      • Workspace call settings
      • Workspace locations
      • Webex schedules
      • Device configuration profiles
      • Webex App manual steps
      • Test device configuration profile rendering
      • Webex App hunt groups
      • Webex App call park
      • Webex App auto attendants
      • Webex App call pickup
      • Webex servers
      • Webex Application Access (Webex Organization)
      • Webex App licenses
      • Network device lists (NDLs)
      • Webex Application Access (Webex Organization)
      • Webex App licenses
      • Webex location node mapping
      • Webex Calls
      • Webex Meetings
      • Webex Meeting Qualities
      • Webex locations
      • Webex Workspaces
      • Webex devices
      • Device configuration profiles
      • Test device configuration profile rendering
      • Configuration templates
      • Introduction to Cisco Webex App
      • Cisco UCM configuration
      • Add Cisco UCM group
      • Clone an instance of a Cisco UCM device model
      • Multi-cluster or single cluster configurations
      • Configure intelligent proximity for mobile voice
      • Cisco UCM servers
      • Headsets
      • Headset enablement
      • User field mapping
      • Network device lists (NDLs)
      • Device Mobility Info
      • Softkey templates
      • Cisco UCM IP phone services
      • Introduction to Phone-Based Registration (PBR)
      • Register a phone for phone-based provisioning
      • Introduction to Phone Services
      • Add PBR config records
      • Cisco UCM IP phone services
      • Add a self-provisioning universal device template
      • Add a self-provisioning universal line template
      • Cisco phones
      • Enhanced INI filtering
      • Configure phone services
      • Manage Phone Services
      • Add phone-based registration menus and access profile
      • Create Restricted API Role and Admin User
      • Install Phone-based Registration (PBR) Web Service
      • Configure Cisco UCM for AutoRegistration and PBR
      • Time periods
      • Time schedules
      • Add a self-provisioning user profile
      • Add self-provisioning line mask
      • Add a self-provisioning universal device template
      • Add a self-provisioning universal line template
      • IOS device management
      • Add an IOS device
      • Command builders
      • Local break out and analog gateway configuration and generated events
      • Local break out and analog gateway events, IOS commands, and variables
      • MGCP analog gateway events and IOS commands
      • Translation rule numbering
      • Analog gateways
      • Add a port to an analog gateway
      • SIP gateway port
      • Quick add SIP gateway
      • SIP local gateway
      • Associate or disassociate SIP local gateway to a site
      • IOS gateway manual configuration
      • IOS device management
      • SIP local gateway
      • Associate or disassociate SIP local gateway to a site
      • Quick add SIP gateway
      • SIP gateway port
      • Configuration templates
      • Cisco UCM translation patterns
      • Calling search spaces
      • Calling party transformation patterns
      • Configure called party transformation patterns
      • Configure UCCX server
      • Introduction to Webex Contact Center
      • Contact Center
      • Webex Contact Center sync
      • Webex Contact Center customer experience
      • Webex Contact Center user management
      • Webex Contact Center Desktop Experience
      • Webex Contact Center Advanced
      • Agent Lines
      • Tag CTI port as Contact Center agent line
      • Introduction to Contact Center Service
      • Configure Contact Center server using Cisco UCM
      • Built-in-bridge
      • Add a Contact Center server
      • Edit or delete Contact Center servers
      • Add a Contact Center service
      • Edit or delete Contact Center services
      • Configure CTI Port
      • Call Manager Groups
      • Cisco UCM group counts
      • Locations
      • Date time groups
      • Cisco UCM group selection
      • Device pools
      • Configure regions
      • Media resources
      • Cisco dial plan models
      • Cisco UCM Music on Hold (MOH) file management
      • Using Automate to manage FAC
      • Introduction to Forced Authorization Codes (FAC)
      • Using device models to manage FAC
      • Customize authorization levels
      • Customize Help
      • Call park management
      • SIP profiles
      • SIP trunks
      • SIP trunk security profiles
      • Introduction to EMCC
      • EMCC groups
      • Configuration templates
      • EMCC configuration templates
      • EMCC route patterns
      • Route groups
      • Route lists
      • Route partitions
      • SIP route patterns
      • Cisco UCM route patterns
      • CTI route points
      • Call Redirection Routing Plan for Disaster Recovery
      • Analog gateways
      • Add a port to an analog gateway
      • Run Cisco UCM LDAP directory sync
      • User authentication
      • Configure Cisco Emergency Responder (CER)
      • Associate CER with Customers
      • View associated clusters on CER servers
      • Introduction to load balancing
      • Load balancing using site default device pool
      • Associate a UCM group to a device pool
      • Introduction to VOSS phone server
      • Managing VOSS phone servers
      • Add phone types
      • Introduction to conferencing
      • Conference workflows
      • Add a Pexip server
      • AudioCodes Devices
      • Schedules
      • Add greeting files
      • Call handler (auto attendant) schedule
      • Language filters
      • CUC servers
      • Network device lists (NDLs)
      • Class of Service (User)
      • Call handler
      • Introduction to Unity SIP integration
      • Configure the Unity SIP Integration menu layout
      • Access profile changes
      • Unity SIP Integration
      • Integrate Unity-Call Manager
      • Add or delete a Unity tenant
      • Dial plan profile
      • Integration log
      • Remove Integrate Unity-CallManager
      • Voice mail services
      • Pilot numbers
      • Associate or disassociate voice mail services to a customer
      • Associate or disassociate pilot number and site
      • Timezone filters
      • LDAP server
      • LDAP authentication
      • Write-back to Active Directory LDAP
      • LDAP user sync
      • Configure LDAP authentication-only (standalone)
      • Sync or purge LDAP users
      • User field mapping
      • LDAP custom role mappings
      • LDAP schedule
      • Introduction to Insights monitoring
      • Insights Assurance Arbitrators
      • Onboard assets
      • Offboard assets
      • Microsoft Operator Connect management in Automate
      • Introduction to data sync
      • Data sync types
      • Full sync
      • Manually run the default data sync
      • Model Type Lists (MTL)
      • Create a custom data sync
      • Schedules
      • Model instance filters
      • Default Cache Control Policy
      • Allowlists and denylists
      • Cisco UCM Change Notification (CNF) Sync
      • Bulk Schedule Activation / Deactivation
      • Datasync Builder
      • Cisco Custom Dial Plans
      • Multi-Cluster Dial Plan Maintenance
      • Dial Plan Model Bulk Loader
      • Dial Plans
      • Dial Plan Viewer
      • Dial Plan Input Data
      • Dial Plan Log
      • Dial Plan Maintenance
      • Dial Plan Management Tool
      • Cisco dial plan models
      • Cisco dial plan models
      • Introduction to Microsoft Teams dial plan management
      • Microsoft dial plan models
      • Configure Microsoft tenant dialplan
      • Introduction to UC Prep
      • UCPrep profiles
      • UCPrep Profile Push
      • Configuration templates
      • Introduction to Cisco HCS dial plan
      • Dial plan roles and privileges
      • HCS dial plan macros in Automate
      • Dial plan schemas
      • Auto-cloning of dial plan schemas and schema groups to the provider hierarchy node
      • Clone dial plan schemas
      • Class of Service (User)
      • Line classes of service
      • Dial plan schema group
      • Site dial plans
      • Associate custom dial plan schema group
      • Short codes
      • Site short codes
      • Emergency and CLI settings
      • Directory number routing
      • Customer HCS Dial Plan
      • Cisco UCM translation patterns
    • Number Management
      • Introduction to number management in Automate
      • AudioCodes device number integration
      • Move number inventory instances
      • Number status and usage
      • Number range management
      • Number cooling
      • Number reservation
      • Reserve numbers for a user
      • Number inventory audit
      • Number inventory alerting
      • Prevent duplicate numbers
      • Number inventory
      • View number details and usage
      • Line Search
      • Introduction to E164 inventory management
      • E164 numbers in the number inventory
      • Add an inventory of E164 numbers
      • View an E164 inventory and delete E164 numbers
      • E164 associations ( N to N DN )
      • E164 associations ( N to 1 DN )
      • Migrate translation patterns for E164 to internal number associations
    • Users & Services
      • Move a Microsoft user between sites using offboard and onboard
      • Multi vendor users
      • Microsoft Quick User
      • Move user & services
      • Microsoft - Move user & services
      • User calling settings
      • User voice mail settings
      • Microsoft Teams CSOL users
      • View users
      • Add admin user
      • Update a user
      • Manage local administrators and operators
      • View and update LDAP authentication users
      • Onboard user (Microsoft)
      • Offboarding (Microsoft)
      • Offboard user (Webex or Microsoft)
      • Microsoft users
      • User staging
      • Microsoft Exchange
      • Multi vendor users
      • Cisco Webex App users
      • Webex Quick User
      • View users
      • Add admin user
      • Update a user
      • Manage local administrators and operators
      • View and update LDAP authentication users
      • Onboard user (Cisco)
      • Offboard user (Webex or Microsoft)
      • Move user & services
      • Webex devices
      • Replace device
      • Webex Workspaces
      • Reset devices to baseline
      • Quick Add Webex Device
      • Multi vendor users
      • Cisco Quick User
      • Provision the Voice Service
      • Provision the extension mobility service
      • Provision the Jabber or dual mode device service
      • Enable self-provisioning
      • Enhanced INI filtering
      • View users
      • Add admin user
      • Update a user
      • Manage local administrators and operators
      • View and update LDAP authentication users
      • Move user & services
      • Move user
      • Reassign user services
      • Convert user type CUCM-LDAP to CUCM Local
      • Onboard user (Cisco)
      • Cisco UCM users
      • Add Subscribers: User
      • Reset UC Passwords
      • Provision the Pexip Conference service
      • Pexip Conference Users
      • Cisco phones
      • Smart add phone
      • Move Phones
      • Moving phones from site to site
      • Configure Phone Move Customizations
      • Enhanced INI filtering
      • PLAR (Hotdial)
      • EM Login/Logout
      • Replace phone
      • Headsets
      • VOSS phones
      • Add controlled device to Cisco user
      • Voicemail
      • Single number reach
      • Intercom Lines
      • Extension mobility
      • Lines
      • Shared line across sites
      • Inventory site
      • Cisco Phone Status Export
      • Add application users to device
      • Add devices to application user
      • Headsets
      • Reset-Restart Site Phones
      • End-user provisioning workflow
      • User provisioning use cases
      • View a user’s provisioning status
      • User login options by auth method and server auth scope
      • User authentication
      • Credential policies
      • Standard users and login
      • LDAP users and login
      • SSO users and login
      • Enable multi vendor users
      • Role-based access for multi vendor users
      • Introduction to Cisco-Microsoft hybrid
      • Hybrid Cisco-Microsoft management
      • Hybrid service definitions
      • Introduction to user syncs
      • User sync source
      • User field mapping
      • Authentication and passwords in user syncs
      • Sync or purge LDAP users
      • Re-provision synced LDAP users
      • Sync Cisco UCM users, lines, and phones
      • LDAP sync actions
      • Purge a Cisco UCM user from Automate only
      • Introduction to self-provisioning
      • Enable self-provisioning
      • Bottom-up user management
      • Top-down user management
      • Cisco UCM configuration for self-provisioning
      • Site configuration for self-provisioning
      • Generate a user’s primary line
      • Specify the primary line per user
      • Add a self-provisioning universal device template
      • Add a self-provisioning universal line template
      • Add a self-provisioning user profile
      • Set a default user profile for a site
      • Add self-provisioning line mask
      • Push users to Cisco UCM
      • Automatically move users synced from Cisco UCM
      • Move users
      • Site-to-site user move transaction log errors
      • Manage duplicate usernames
      • Session timeout rules
      • Timeout limit notifications
      • Manage passwords
      • Passwords and manually added users
      • Force a user to change their password
      • Force administrators to change their password
      • Change your own password
      • Unlock a locked user account
      • Unlock a locked admin account
      • Manually disable a user account
      • Manually disable an admin account
      • Introduction to Self-service
      • Self-service and user configuration
      • Create a Self-service link
    • Call Groups
      • Auto attendants
      • Resource Accounts
      • Call Queues
      • File management
      • Holidays
      • Automate - Call Groups - Webex Call Groups
      • Hunt groups
      • Shared line across sites
      • Call handler
      • File management
      • Call Pickup Groups
      • Call handler (auto attendant) schedule
    • Security Management
      • Microsoft Defender setup, sync and overbuild
      • Microsoft Defender for Office security management and policies
      • Microsoft Defender for Endpoint security management and policies
    • Insights Dashboards
      • Introduction to Microsoft Insights
      • Digital Experience Monitoring (DEM) Agent Installation Architecture and Requirements
      • Connectivity
      • Agent Installation
      • Digital Experience Monitoring Agents and profiles
    • System Configuration
      • Introduction to customizations
      • Model filter criteria
      • Configuration templates
      • Field display policies
      • Macros
      • Drop-down filters
      • Quick Add Groups
      • User profiles
      • Flow through provisioning (FTP)
      • Manage number filters
      • Create a filter to move users
      • Datasync builder templates
      • Datasync profiles
      • System monitoring configuration
      • System monitoring model counts
      • Login sessions
      • UC apps reachability
      • System monitoring database statistics
      • Automate cluster status
      • Worker queue
      • Add a SMTP server
      • Email
      • Macros
      • Configuration templates
      • Global settings
      • Countries
      • Configuration mapping for phones, device profiles, and lines
      • Line delete preferences
      • Site defaults
      • Language filters
      • Timezone filters
      • Site Defaults Doc templates
      • Network device lists (NDLs)
      • Reassign user services
      • Configuration templates
      • Distributing Licensing Reports
      • Introduction to entitlement
      • Add a device type
      • Entitlement catalogs
      • Add device group
      • Entitlement profiles
      • Entitlement enforcement
    • System Functions
      • Automate - Additional Admin Functions - Transaction Overview
      • Add Custom Variables
      • Transaction logging and audit
      • Bulk load transactions
      • View a transaction
      • Transaction log levels
      • Transaction Details
      • Filter Transactions
      • Filter Sub-Transactions and Logs
      • Transaction Behavior
      • Transaction Priority
      • Transaction Log Example
      • Device data sync errors in transactions
      • Export a transaction
      • Bulk load
      • Data export Overview
      • Bulk export of model data
      • Bulk load template export
      • Bulk load sheets
      • Sample bulk loaders
      • Bulk load template sheet layout
      • Export data sheet layout
      • Bulk load sheet macro evaluation
      • Bulk load transactions
      • Import
      • Alerts
      • Dashboard Exports
      • Schedules
      • Introduction to overbuild
      • Overbuild for Cisco
      • Run overbuild
      • Overview tool
      • Run dial plan overbuild
      • User phone associate tool
      • Overbuild Analog Gateway
      • Device Models
      • Locate a user associated with a CUC device model
      • Filter calling search spaces and assign a class of service
      • Overbuild for Microsoft
      • File management
      • Create Model Report
      • Manage Model Reports
      • Create Line Reports for a Site
      • View Line Reports
      • Template customization audit tool
      • Settings
      • Set up a Web Proxy
      • Northbound Notification
      • Notification Format
      • NBN Transaction Processing
      • Northbound Notification Workflow
      • Configure Northbound Notification Destination
      • Configure Northbound Notification Event Attributes
      • Configure Northbound Notification event
    • Self-service Administration
      • Introduction to Self-service Administration
      • Self-service feature display policy
      • End User Access and Authentication
      • Themes and Branding
      • Self-service Login Banner
      • Personal Phones (Remote Destinations)
      • Dual Mode Phones - Mobile ID
      • Voicemail for Self-service
      • Links Page
    • Dashboard and Menu Reference
      • Introduction to the default reference menus and dashboards
      • Menu: Automate - Admin
      • Menu: Automate - Admin - Microsoft Only
      • Menu: Automate - Analyst
      • Menu: Automate - License Manager
      • Menu: Automate - Service Desk
      • Menu: Automate - Service Desk - Microsoft Only
      • Menu: HcsAdminMenu
      • Menu: HcsSAMenu
      • Menu: Insights - Admin
      • Automate - Additional Admin Functions - Admin Tools
      • Automate - Additional Admin Functions - Data Sync
      • Automate - Additional Admin Functions - Transaction Overview
      • Automate Analyst - Hierarchy
      • Automate Analyst - Home
      • Automate Analyst - Microsoft Overview
      • Automate Analyst - Number Management
      • Automate Analyst - Users & Services - Cisco User Services
      • Automate Analyst - Users & Services - Microsoft User Management
      • Automate Analyst - Users & Services - Webex Contact Centre User Services
      • Automate Analyst - Users & Services - Webex User Services
      • Automate Analyst - Webex Overview
      • Automate - Call Groups - Cisco Call Groups
      • Automate - Call Groups - Microsoft Call Groups
      • Automate - Call Groups - Webex Call Groups
      • Automate - Hierarchy Management
      • Automate - Home
      • Automate - Microsoft - Exchange
      • Automate - Microsoft - Home
      • Automate - Microsoft Insights
      • Automate - Microsoft - License Management Analysis
      • Automate - Microsoft - License Management
      • Automate - Microsoft - Microsoft User Management
      • Automate - Microsoft - User Overview
      • Automate - Number Management
      • Automate - Role Based Access
      • Automate - Security Management - Defender for Endpoint Actions
      • Automate - Security Management - Defender for Endpoint Overview
      • Automate - Security Management - Defender for Office Actions
      • Automate - Security Management - Defender for Office Overview
      • Automate Service Desk - Additional Admin Functions - Admin Tools
      • Automate Service Desk - Role Based Access
      • Automate - System Configuration
      • Automate - UC Integration - Cisco CUC Detailed Configuration
      • Automate - UC Integration - Cisco CUCM Detailed Configuration
      • Automate - UC Integration - Cisco Webex Contact Centre Configuration
      • Automate - UC Integration - Cisco Webex Detailed Configuration
      • Automate - UC Integration - Dialplan Tools
      • Automate - UC Integration - Extended UC App Configuration
      • Automate - UC Integration - Microsoft Detailed Configuration
      • Automate - UC Integration - Microsoft Overview
      • Automate - UC Integration - SBC Management
      • Automate - UC Integration - Webex Overview
      • Automate - Users & Services - Cisco User Services
      • Automate - Users & Services - Microsoft User Management
      • Automate - Users & Services - User Details
      • Automate - Users & Services - User Overview
      • Automate - Users & Services - Webex Contact Centre User Services
      • Automate - Users & Services - Webex User Services
      • Automate - VOSS License Overview
      • DEM Agent Stats
      • DEM System Trace Details
      • DEM System Trace Status
      • DEM Web Service Status
      • ENTAdminDashboard
      • HcsAdminDashboard
      • HcsSysadminDashboard
      • Insights - Additional Admin Functions - Admin Tools
      • Insights Admin - Arbitrator Management
      • Insights - Admin Home
      • Insights - Diagnostics
      • Insights - Digital Experience Monitoring
      • Insights Microsoft License & User Device Stats
      • Insights Microsoft Teams Active Directory User List
      • Insights Microsoft Teams Audio Device
      • Insights Microsoft Teams Call Activity Trends
      • Insights Microsoft Teams Call Audio Device Detailed
      • Insights Microsoft Teams Call Detail
      • Insights Microsoft Teams Call List Call Queues
      • Insights Microsoft Teams Call List Combined
      • Insights Microsoft Teams Call List
      • Insights Microsoft Teams Call List Teams Rooms
      • Insights Microsoft Teams Call Review Detailed
      • Insights Microsoft Teams Calls with Issues
      • Insights Microsoft Teams Devices
      • Insights Microsoft Teams Diagnostic Call Debug
      • Insights Microsoft Teams Direct Routing Call Analysis
      • Insights Microsoft Teams PSTN Calls
      • Insights Microsoft Teams Service Health
      • Insights Microsoft Teams Site Quality
      • Insights Microsoft Teams Usage Analysis
      • Insights Microsoft Teams User Experience Overview
      • Insights Microsoft Teams User Review - Call Trends
      • Insights Microsoft User Usage Analysis
      • Insights - Performance - Service Management
      • Insights - System Configuration
      • Insights - Usage & Adoption
      • Insights - User & Device Inventory
      • Insights Webex Calling
      • Insights Webex Devices
      • Insights Webex Licenses
      • Insights Webex Locations and Workspaces
      • Insights Webex Meetings Quality
      • Insights Webex Participant
      • Insights Webex Users
      • selfservice_dashboard
    • Appendix: Glossary
      • Glossary
  • Self-service Guide
    • Purpose
    • Audience
    • Conventions
    • Accessing Self-service
    • First Login and Password Expiry or Reset
    • Accessing Minimal Mode
    • Manage Your Self-service
    • Configure Your Password Reset Questions
    • Reset Your Password
    • User Interface
    • Available Features and Services
    • Session Timeout
    • Buttons and Icons
    • Common Tasks
    • Home
    • My Information
    • Change Your User Language
    • Manage Your Password and PIN
    • Change Your Password
    • Password Hints and Rules
    • Change Your PIN
    • Access Webex
    • Phones
    • Manage a Phone
    • Add Your Own Smart Device
    • Edit a Smart Device
    • Bulk Modify Your Company Phones
    • Your Personal Phone Management
    • Add a Personal Phone
    • Edit a Personal Phone
    • Delete a Personal Phone
    • Bulk Modify Your Personal Phones
    • Voicemail Settings
    • Create your own Voicemail Account
    • Change your Voicemail Settings
    • Alternate Numbers and Notification Devices
    • Manage Alternate Numbers and Notification Devices
    • Caller Input
    • Manage Caller Input Keys
    • Message Actions
    • Manage Message Actions
    • Call Forwarding
    • Activate and Manage a Line for Call Forwarding
    • My Availability
    • Set Do Not Disturb for your Phone
    • Speed Dials and BLFs
    • Manage Speed Dials and Busy Lamps (Phone Button Template)
    • Add a Speed Dial (Abbreviated Dials)
    • Links
  • Architecture and Hardware Specification Guide
    • Automate deployment topologies
    • Automate hardware specifications
    • Scale and performance
  • Installation Guide
    • What’s New
    • Overview
    • File transfer protocol and commands
    • Clustering commands
    • Determine the primary node role in a cluster
    • Geo-redundancy/redundancy and disaster recovery
    • Using the tmux command
    • Automate deployment topologies
    • Multi data center deployments
    • Clustering
    • Network communications between nodes within the cluster
    • Network communications external to the cluster
    • Network Docker container range
    • Backup size considerations
    • Automate hardware specifications
    • Supported virtualization and hypervisor platforms
    • VMWare Esxi 8
    • Hyper-V
    • Nutanix
    • Installation overview
    • Platform install on a VM
    • Inspect the logs to troubleshoot installation
    • Installation Quick Reference
    • Multinode installation
    • Single-node cluster (cluster-of-one) installation
    • View Installation and Upgrade Transactions
    • Migrating from a 6 Node to 8 Node System
    • Modular architecture multinode installation
    • Azure Cloud Deployment
    • AWS Deployment
  • Upgrade Guide with ISO and Template
    • Before upgrading
    • Upgrade and data migration
    • Using the screen command
    • Using the tmux command
    • Automate hardware specifications
    • Upgrade Automate
  • Upgrade Guide with Delta or Patch Bundle
    • Upgrade Path and Dependencies
    • Delta Bundle Overview
    • Important Information
    • Download Location
    • Delta Bundle Upgrade
    • Post-install checks
    • Rollback
  • Multi-Cluster Deployments Technical Guide
    • Introduction
    • Deployment Recommendations
    • Caveats and Limitations
    • Overview
    • Deployment Recommendations
    • Caveats and Limitations
    • Overview
    • Deployment Recommendations
    • Caveats and Limitations
    • Deployment Recommendations
    • Deployment Recommendations
    • Caveats and limitations
    • Overview
    • Number Inventory
    • HCS Dial Plans GDPR Support
    • HCS Dial Plan Type Considerations for GDPR
    • ILS/GDPR
    • Intercluster Trunking
    • HCS Dial Plans
    • Overbuild Considerations
    • Scenarios
    • Notes
    • Single telephoneNumber MIF
    • Multiple telephoneNumber MIF
    • Intercluster Trunking, ILS/GDPR CFTs
  • Platform Guide
    • What’s New
    • High-level Functions
    • Overview
    • CLI Commands
    • Clustering commands
    • Using the tmux command
    • VOSS Management Tools
    • Install Commands
    • Database Commands
    • Database Commands for Transaction Management
    • Performance Commands
    • System Specific Commands
    • Transaction archiving
    • Product Licensing
    • Report Transaction Commands
    • Report API Commands
    • Introduction
    • Subscriber data export command
    • Deployment Commands
    • Migrate a Unified Node Cluster to a Modular Cluster
    • Determine the primary node role in a cluster
    • Provisioning
    • Network interfaces
    • Switching Network Addresses from IPv4 to IPv6
    • Network services
    • Network URI specification
    • Network Docker container range
    • Application Control and Status
    • Starting and Stopping
    • Installing Applications
    • Updating Applications
    • Summary Attribute Migration
    • Remote Execution in Clusters
    • List of Unused Cluster Commands
    • Self-service Localization Management
    • Web Services
    • Insights Analytics
    • System Commands Overview
    • System restart
    • Passwords
    • System Boot Passwords
    • Federal Information Processing Standards (FIPS)
    • File Management
    • Drive control
    • Transaction Prioritization
    • Banner
    • Maintenance Mode
    • Checksum
    • Terminal Reset
    • Login Report
    • Cluster Check
    • Enable Health Monitoring
    • Enable Database Scheduling
    • Command History
    • Logs
    • Viewing Logs
    • Sending and Collecting Logs
    • Log Types
    • Audit Log Rule Sets
    • Log Type Commands
    • Audit Log Format and Details
    • Event Log Format and Details
    • Log Streaming
    • Remote Log Type Encryption
    • The Mail Command
    • Diagnostic Tools
    • Diagnostic Troubleshooting
    • Warnings and Notifications
    • Events and SNMP Messages
    • SNMP Configuration and Queries
    • Introduction to SNMP and MIB
    • SNMP Traps
    • Management Information Bases
    • Notification Messages
    • SNMP Traps: Number Inventory Alerting
    • SNMP Traps: System Monitoring
    • Scheduling
    • Internal Report Schedules
    • Backups
    • Backup and restore in a modular architecture
    • Backup destinations
    • Backup passphrase
    • Backup size considerations
    • Create a backup
    • Restore a backup in a clustered environment
    • Create space for a backup or restore
    • Maintaining Backups
    • Backup and import to a new environment
    • VMware snapshot maintenance
    • Backup on Azure
    • Introduction to Restoring Backups on a New Environment
    • Setting up the Backup Passphrase on a New Environment
    • Adding More Hard Disk Space
    • Reassign Current Drives (Backup and DBroot)
    • Restore the Backup
    • Example of a Successful Restore
    • Introduction to system security
    • Configuration Encrypted
    • Backup Encrypted
    • Application Install Files Encrypted
    • File Integrity
    • Protected Application Environments (Jails)
    • Restricted user shell
    • User Security and Security Policy Management
    • Creating Additional Users
    • Creating and Managing SFTP Users
    • Granting and revoking user rights
    • Password Strength Rules
    • SSH Login Fail Limit
    • SSH Session Limit
    • SSH key management
    • SSH Algorithm Management
    • Adding a Key for Automatic User Login
    • Prevention of DOS Attacks
    • Memory Dumps and Security
    • Manage Read-Only Database Users
    • System Intrusion Detection
    • Network communications between nodes within the cluster
    • Network communications external to the cluster
    • Dynamic Firewall
    • Web Certificate Setup Options
    • Supported SSL Ciphers
    • VOSS Automate Setup a Web Certificate
    • Own Web Certificate Setup
    • Web Certificate Expiration Notice
    • Convert Web Certificates from P7B to PEM Format
    • Web Certificate Commands
    • Web Hosts Commands
    • Web TLS Protocol Configuration
    • Web TLS Cipher Management
    • Network URI specification
    • Web External Proxies
    • High Availability Overview
    • Default HA and DR scenario
    • HA and DR scenario with Cisco VMDC geo-redundancy architecture
    • Configuring a HA System Platform on VMware
    • DR Failover
    • Cluster Failure Scenarios
    • Platform install on a VM
    • Election of a New Primary and Failover
    • DR Failover and Recovery Scenarios
    • Scenario: Power Off and On of a Node
    • Scenario: Loss of a Non-primary Node in the Primary Site
    • Scenario: Loss of a Non-primary Server in the DR Site
    • Scenario: Loss of the Primary Database Server
    • Scenario: Loss of a Primary Site
    • Scenario: Loss of a DR Site
    • DR Failover and Recovery in a 2 Node Cluster
    • Scenario: Loss of Full Cluster
    • Modular Cluster: Election of a New Primary and Failover
    • DR Failover and Recovery Scenarios in a Modular Cluster
    • Scenario: Power Off and On of a Node in a Modular Cluster
    • Scenario: Loss of an app node: Modular Cluster
    • Scenario: Loss of the Primary Database Server in a Modular Cluster
    • Scenario: Loss of a non-primary database: Modular Cluster
    • Scenario: Loss of a Primary Site in a Modular Cluster
    • Scenario: Loss of a DR Site in a Modular Cluster
    • Scenario: Loss of Full Cluster in a Modular Cluster
    • Platform User Password Recovery Procedure
    • ‘No Space Left on Device’ Error
    • Loss of the whole cluster and redeploying new servers
    • Error Messages
    • MIB List
    • Analogue line MGCP Data Export
    • Analogue Line SCCP Data Export
    • Call Pickup Group Data Export
    • Contact Center Enterprise Data Export
    • Contact Center Express Data Export
    • Customer Data Export
    • Extension Mobility Data Export
    • FMC Data Export
    • Hunt Group Data Export
    • Hybrid Data Export
    • Line Data Export
    • Phones Data Export
    • Site Data Export
    • Subscriber Data Export
    • Webex Teams Data Export
    • Webex Devices Data Export
    • Webex Workspaces Data Export
    • MS Office 365 Data Export
    • MS Teams Data Export
    • MS Exchange Data Export
    • Pexip Data Export
    • VOSS phone servers data export
    • diag Command Examples
    • SNMP Traps: Applications examples
    • SNMP Traps: Load examples
    • SNMP Examples: Backup
    • SNMP Trap Examples
  • Health Checks for Cluster Installations Guide
    • Introduction
    • Notification/SNMP setup
    • Check general cluster health
    • Verify web proxy sanity
    • Verify database status
    • Resource utilization checks
    • VMWare checks
    • Backup / export
    • Latency
    • Firewall configurations
    • Data collection for offline analysis
  • Best Practices Guide
    • What’s New
    • Use the Action search to navigate Automate
    • Automate deployment topologies
    • Overview
    • Active-Active web weights
    • Active-StandBy web weights
    • Session limits
    • Throttle limits
    • Configurable number of queue processes
    • Planning guidelines for onboarding and ongoing operations
    • Add Automate over an existing Webex organization
    • Sync overview
    • Data sync types
    • Schedules
    • Cisco UCM sync
    • Cisco UCM Change Notification (CNF) Sync
    • Recommended Cisco UCM sync setups
    • CUC sync
    • LDAP sync
    • Cisco Webex App sync
    • Microsoft syncs
    • Microsoft tenant setup
    • Recommended RIS API data collector interval
    • API resource listing best practice
    • Long running API requests
    • Transaction archiving
    • Automated database cache cleanup
    • Navigation - menu and dashboards
  • Advanced Configuration Guide
    • What’s New
    • Use the Action search to navigate Automate
    • Login notification banner
    • Transaction log levels
    • Settings
    • Global settings
    • Number cooling auto expiry schedule
    • Add a SMTP server
    • Email
    • Associate / disassociate devices to application users
    • INI purge tool
    • System monitoring configuration
    • System monitoring database statistics
    • System monitoring model counts
    • Automate cluster status
    • UC apps reachability
    • Worker queue
    • Login sessions
    • Feature package customization
    • Field display policies
    • Field display policy settings
    • Example field display policy clone
    • Configuration templates
    • Add a configuration template
    • Configuration templates for array updates
    • Events
    • GUI rules
    • GUI rule for the target model of a configuration template
    • Relations
    • Tags
    • Add and remove tags
    • Add a view
    • Less files and customizing themes
    • Theme banner customization
    • Privacy policy menu items
    • Manage privacy policy menu items
    • Manage themes
    • Theme element color references for the Admin portal
    • Automate cookie policy
    • Menu diff tool
    • Online help customization
    • Online help model override options
    • Scripts
    • Add and run a script
    • Expect script examples
    • Expect script import format
    • Network device list selection rules advanced configuration
    • Change LDAP user sync
    • Data sync workflows
    • Number inventory flexibility and description customization
    • Configuration overview
    • Site defaults reference
    • Introduction to named macros
    • Customizing quick add groups
    • Quick add user provisioning workflow structure
    • User relation context
    • Config template looping and merging overview
    • Config template looping
    • Config template merge strategy
    • Custom line settings for Smart Add Phone configuration template
    • Reference material
    • Lines - site defaults
    • Phones - site defaults
    • User - site defaults
    • Quick user (subscriber) - site defaults
    • Voicemail - site defaults
    • Webex - site defaults
    • Hot dial PLAR - site defaults
    • Hunt groups - site defaults
    • Call pickup groups - site defaults
    • Configuration template reference list
    • Named macros available to administrators
    • Named macros - site defaults general
    • Named macros - site defaults device
    • Named macros - site defaults line
    • Named macros - site defaults user
    • Named macros - site defaults CUC
    • Named macros - site defaults Hotdial
    • Named macros in configuration templates
    • Pull sync delete threshold
    • Macros
    • Macro syntax brackets
    • Macro syntax multiline
    • Dot notation
    • SELECT FROM WHERE macro syntax
    • Macro nesting
    • Macro syntax to filter by meta properties
    • Macro function syntax
    • Numeric functions
    • String functions
    • List functions
    • Model filters
    • Model instance filters from CSV file
    • Rule filter functions
    • Role at allowed hierarchy function
    • Filter role functions
    • Macro evaluate function
    • CUCM and device functions
    • Jabber device name function
    • Webex App functions
    • Subscriber functions
    • Quick add group functions
    • Zero, unset, boolean, drop, null, and exists functions
    • Time functions
    • Hierarchy functions
    • User details functions
    • Number management functions
    • Phone functions
    • Localization functions
    • Log functions
    • Object functions
    • Conversion functions
    • HTTP functions
    • Email functions
    • Macro examples - simple
    • Macro examples - list macro
    • Macro- and macro function nesting
    • Conditional logic macro function
    • Add a macro inline
    • Add a macro for re-use
    • Create a value substitution macro
    • Substitution macro examples
    • Add an evaluation macro
    • Evaluation macro examples
    • Macro evaluator
  • BulkLoader Provisioning Guide
    • What’s New
    • Overview
    • Use the Action search to navigate Automate
    • Bulk load
    • Data export Overview
    • Bulk load template export
    • Bulk load sheets
    • Bulk load template sheet layout
    • Sample bulk loaders
    • Export data sheet layout
    • Template location and template reference set
    • Bulk load sheet macro evaluation
    • Bulk load transactions
    • Bulk export of model data
    • Bulk load API
  • Provider HCS Dial Plan Management Support Guide
    • What’s New
    • Use the Action search to navigate Automate
    • Telephony, design, and HCS dial plan overview
    • Introduction to the dial plan model in Automate
    • Dial plan roles and privileges
    • Customer HCS Dial Plan
    • Site dial plans
    • Line classes of service
    • Short codes
    • Directory number routing
    • Customers
    • Introduction to number management in Automate
    • Number inventory
    • View number details and usage
    • E164 numbers in the number inventory
    • Number status and usage
    • Number range management
    • Number cooling
    • Number reservation
    • Number inventory alerting
    • Number inventory audit
    • Introduction to E164 inventory management
    • Add an inventory of E164 numbers
    • View an E164 inventory and delete E164 numbers
    • E164 associations ( N to N DN )
    • E164 associations ( N to 1 DN )
    • Migrate translation patterns for E164 to internal number associations
    • Configure inter-site cross-cluster support
    • Manually configure local breakout support
    • Voice mail services
    • Associate or disassociate voice mail services to a customer
    • Pilot numbers
    • Creating DDIs for voice mail pilot numbers
    • Associate or disassociate pilot number and site
    • Add aggregation trunk and route group and associate to existing route list and SLRG
    • SIP profiles
    • SIP profile configuration
    • SIP trunk security profiles
    • SIP trunk security profile configuration
    • SIP trunks
    • SIP route patterns
    • Route groups
    • Route lists
    • Date time groups
    • Locations
    • Device pools
    • Call Manager Groups
    • Route partitions
    • Calling search spaces
    • Calling party transformation patterns
    • Configure called party transformation patterns
    • CTI route points
    • Time periods
    • Time schedules
    • Clone an instance of a Cisco UCM device model
    • Introduction to load balancing
    • Load balancing using site default device pool
    • Associate a UCM group to a device pool
    • Update the USA device-based routing dial plan
    • Shared line across sites
    • Inventory site
    • Site short codes
    • Configure tail end hop off
    • HCS dial plan macros in Automate
    • Auto-cloning of dial plan schemas and schema groups to the provider hierarchy node
    • Dial plan schemas
    • Clone dial plan schemas
    • Site defaults
    • Run overbuild
    • Overriding Cisco UCM group
    • Dial plan schema group
    • Associate custom dial plan schema group
    • Default dial plan schemas
    • Emergency and CLI settings
    • Default dial plan event triggers
    • Manual configuration to correct calling presentation overwrite on calls forwarded to PSTN
    • Global settings
    • Add a SMTP server
    • Email
    • Intra-site extension dialing
    • Multi-site customer with ISP included in SLC
    • Multi-site customer with extension prefix and no ISP
    • Single Site Customer
    • Customer (single- or multi-site) without PSTN prefix
    • Multi-site customer with ISP
    • Intra-site On-Net call
    • Inter-site On-Net call
    • VoIP trunking On-Net Call
    • Local gateway (LBO)
    • Aggregation (CBO)
    • VoIP
    • Non-CER through aggregation
    • Non-CER through local gateway
    • Cisco emergency responder
    • Introduction to PSTN call processing and routing
    • Dial plan determination
    • Country dial plan deployment overview
    • Predefined country dial plans
    • Install country dial plan (.template file)
    • Install country dial plan (.json file)
    • Add a country dial plan to a dial plan before deploying to a customer
    • Add a country dial plan to a deployed customer dial plan
    • Called party number as dialed feature
    • Plus number dialing customization
    • Correct device-based routing CoS to enable SNR
    • Dial plans for Caribbean countries overview
    • North American numbering plan schema
    • Caribbean countries schema (Optional)
    • Country-specific schema
    • Installing the dial plan
    • Local breakout (LBO) workflows
    • Calling search spaces and partitions
    • Architecture primer
    • Directory numbers classification
    • Extension Numbers
    • Site location codes
    • Full national number
    • E.164 number
    • Intersite prefix
    • PSTN access prefix
    • Call limitations
  • Licensing and Subscriber Data Export Guide
    • What’s New
    • License Count
    • License Audit Report File Details
    • Viewing License Audit Counts
    • Process Command Details
    • Distributing Licensing Reports
    • Set up a Web Proxy
    • System User Audit
    • Troubleshooting and Error Handling
    • Introduction
    • Subscriber data export command
    • Scheduling
    • Using the screen command
    • Analogue line MGCP Data Export
    • Analogue Line SCCP Data Export
    • Call Pickup Group Data Export
    • Contact Center Enterprise Data Export
    • Contact Center Express Data Export
    • Customer Data Export
    • Extension Mobility Data Export
    • FMC Data Export
    • Hunt Group Data Export
    • Hybrid Data Export
    • Line Data Export
    • Phones Data Export
    • Site Data Export
    • Subscriber Data Export
    • Webex Teams Data Export
    • Webex Devices Data Export
    • Webex Workspaces Data Export
    • MS Office 365 Data Export
    • MS Office 365 Service Plans
    • MS Teams Data Export
    • MS Exchange Data Export
    • Pexip Data Export
    • VOSS phone servers data export
    • Network communications external to the cluster
  • API Guide
    • API Introduction
    • API System Concepts
    • Hierarchy
    • Basic REST
    • API Traversal
    • Request and Response Patterns
    • General Structure of the API
    • Format
    • Authentication
    • Authorization
    • HTTP Methods
    • PUT Versus PATCH
    • API Parameters
    • Filter Parameters for Choices
    • API Request Headers
    • Login and Authorization Tokens
    • Non-interactive Login
    • Access Profiles
    • Time to Live (TTL)
    • Account Endpoint
    • API Response Overview
    • API Response Header
    • Single Resource Response
    • Resource List Response
    • POST/PUT/DELETE/PATCH Response
    • Asynchronous Mutator Transaction Status Callback
    • Example of an Asynchronous Mutator Transaction with nowait=true
    • Correlation Identifiers
    • Example Of A Simple HTTP Server
    • Developer Guidelines
    • Workflow Tasks
    • Developer Tools
    • Fault Responses
    • Error Messages
    • Introduction to Tool APIs
    • Search and Search Result Export
    • Bulk load API
    • Move and Bulk Move
    • Data Extract
    • Custom Workflows
    • List Transactions
    • Get Instance Transactions
    • Poll Transactions
    • Replay Transactions
    • Edit and Replay Transactions
    • Sub Transactions
    • Log Transactions
    • Transaction Choices
    • Transaction Filters
    • API Examples Overview and Conventions
    • POST
    • GET
    • PUT
    • DELETE
    • Bulk Load Example
    • Export Example
    • Example Transaction
    • API Backward Compatibility and Import
    • Using the API Reference
    • API Schema
    • Notifications
    • Metadata
    • References
    • Summary Attributes
    • Path
    • Model Type
    • Actions
    • Singleton
    • Choices Generic Action
    • Add Generic Action
    • Bulk Update Generic Action
    • Clone Generic Action
    • Configuration Template Generic Action
    • Create Generic Action
    • Delete Generic Action
    • Execute Generic Action
    • Export Generic Action
    • Export BulkLoad Template Generic Action
    • Field Display Policy Generic Action
    • Help Generic Action
    • List Generic Action
    • Update Generic Action
    • Import
    • Test Connect
    • Apply
    • Assign
    • Do
    • Lock
    • Promote
    • Reset
    • Vendor Config
    • Wipe
    • Update LDAP Authentication
    • Update LDAP System
    • Data
    • Resources
    • Schema
    • Pagination
    • Introduction to Automate OpenAPI Examples
    • GET /tool/Macro
    • Add a standalone Cisco phone
    • Add a Cisco subscriber
    • Reset a CUCM PIN/password and/or CUC PIN
    • Replace a Cisco phone
    • Associate an existing Cisco device or device profile to subscriber
    • Disassociate a Cisco phone from a subscriber
    • Move a Cisco subscriber between sites
    • Modify line data
    • Modify phone data - line recording details
    • Delete a phone
    • Delete a subscriber
  • Language Pack Guide
    • Languages Overview
    • Language Availability and Installation
    • Localization, coverage and caveats
    • Default Language and User Language
    • Selfservice User Languages
    • Language Customization
    • Installation of New Languages
    • Updates to Languages
  • NBI Technical Description and Deployment Guide
    • Overview
    • Introduction
    • NBI Technical Description
    • Billing Payload Definition
    • Integration Considerations and Message Sequencing
    • Operational Matters and Production Hardening
    • Appendix A: Trigger Events and Tracking Table
    • Appendix B: Billing Payload Definition
    • Appendix C: Alarm Definition
  • NBI Troubleshooting Guide
    • NBI SNMP Traps
  • NBI Install Guide
    • Overview
    • Before You Start
    • Software Details
    • Download the Relevant Files
    • VOSS Automate verification
    • Deploy the new install OVA
    • Install and Configure the NBI Application
    • NBI Checks
  • Open Source License Usage
    • Core Application (Python)
    • Platform (Python)
    • Portal (JavaScript)
    • Self-service (JavaScript)
    • Insights API (JavaScript)
    • Insights - VOSS Sync (JavaScript)
    • VOSS Automate Licensing Service
    • Licenses for Code in Binary Files
    • Open Source Licenses for Release 25.3
  • Index
  • What’s New by Feature
  • What’s New by Document
  • .rst
  • Index »
  • NBI Troubleshooting Guide

NBI Troubleshooting Guide

NBI Troubleshooting Guide#

Note

SNMP traps are supported in NBI 4.1.3.

  • NBI SNMP Traps
    • SNMP Traps Table

previous

Appendix C: Alarm Definition

next

NBI SNMP Traps

© Copyright 2025, VISIONOSS LIMITED.