Platform Guide

• What’s New
  • Platform Guide: Release 20.1.1
  • Platform Guide: Release 21.1

Overview

• High-level Functions

The Command Line Interface

• Overview
• CLI Commands
• Using the screen command

System Specific Commands

• VOSS Management Tools
• Install Commands
• Database Commands
• Database Commands for Transaction Management
• Performance Commands
• System Specific Commands
• Transaction Archiving

System Metrics

• Report Transaction Commands
  • Profile
  • Throughput
  • Worker-Usage
  • Current-Usage
• Report API Commands
  • Profile
  • Throughput

Data Export Commands

• Introduction
  • Data Export Overview
• Subscriber Data Export Command

Node Deployment

• Deployment
• Modular Cluster Deployment
• Migrate a Unified Node Cluster to a Modular Cluster
  • Considerations and Prerequisites
  • Steps
  • Removing Database Drives and Volumes
• Primary Node Role in a Cluster

Provisioning

• Provisioning

Networking

• Network interfaces
• Network services
• Network URI specification
• Network Docker Container Range

Application Control

• Application Control and Status
  • Application Status
• Starting and Stopping
• Installing Applications
  • Single Application Installation
  • Multiple Application Installation
• Updating Applications
• Summary Attribute Migration
• Remote Execution in Clusters
• List of Unused Cluster Commands
• Self-Service Localization Management
• Web Services

System Control

• System Commands Overview
• System restart
• Passwords
• System Boot Passwords
• Federal Information Processing Standards (FIPS)
• File Management
• Drive control
• Transaction Prioritization
• Banner
• Checksum

Diagnostics

• Health Report
• Cluster Check
• Enable Health Monitoring
• Enable Database Scheduling
• Command History
• Logs
• Viewing Logs
• Sending and Collecting Logs
• Log Types
• Audit Log Rule Sets
  • Types of command and change logs in audit rules
• Log Type Commands
• Audit Log Format and Details
  • Example Syslog Messages
• Event Log Format and Details
• Log Streaming
• Remote Log Type Encryption
• The Mail Command
• Diagnostic Tools
• Diagnostic Troubleshooting

Notifications

• Warnings and Notifications
• Events and SNMP Messages
• SNMP Configuration and Queries
  • SNMP Configuration
  • SNMP Queries

SNMP

• Introduction to SNMP and MIB
• SNMP Traps
• Management Information Bases

MIB and Trap Details

• SNMPv2-MIB - RFC 3418 - Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)
• IF-MIB - RFC 2863 - The Interfaces Group MIB
• MIB-II - RFC 1213 - Management Information Base for Network Management of TCP/IP- based internets
• IP-MIB - RFC 4293 - Management Information Base for the Internet Protocol (IP)
• TCP-MIB - RFC 4022 - Management Information Base for the Transmission Control Protocol (TCP)
• UDP-MIB - RFC 4113 - Management Information Base for the User Datagram Protocol (UDP)
• HOST-RESOURCES-MIB - RFC 2790 - Management Information Base for Host Resources
• SNMP Traps: System Startup
  • Example: coldStart
• SNMP Traps: Service Startup Changes Made
  • Example: ProcessRestart
  • Example: ProcessWarning
  • Example: ProcessStop
  • Example: ProcessStart
• SNMP Traps: Service Monitoring - Changes Made
• SNMP Traps: Service Status
  • Example: Info
  • Example: Critical
• SNMP Traps: System Shutdown
  • Example: nsNotifyShutdown
• SNMP Trap: Disk Status
  • Severity Messages
  • Example: ERROR: Disk full
  • Example: DISK STATUS
  • Example: ERROR: DISK ALMOST FULL
• SNMP Trap: Database Usage
  • Variable Bindings - DB cache size
  • Variable Bindings - DB transaction size
  • Variable Bindings - DB transaction count
  • Example: WARN: Database transaction size exceeded threshold
• SNMP Trap: Database Maintenance
• SNMP Trap: Excessive Load
  • Example: Critical
• SNMP Trap: Backup and Restore
  • Example: Critical: Backup failed
  • Example: Critical: ERROR: The last backup was more than 2 days ago
  • Example: INFO: Backup now runs regularly
• SNMP Trap: Health Emails
  • Example: ERROR: Trouble sending health email
  • Example: WARNING: Some notify levels are configured with a local email address
• SNMP Trap: Disk Latency
  • Severity Message
  • INFO Example
  • Critical Example
• SNMP Trap: Mailbox Status
  • Example: WARNING
• SNMP Trap: Cluster Status
• SNMP Trap: Database Failover Status
  • Example: INFO
  • Example: ERROR
• SNMP Trap: Large Log Files
  • Severity: Info Trap Example
  • Severity: Urgent Trap Example
• SNMP Trap: Network Status
  • Example: Critical
  • Example: Info
• SNMP Trap: NGINX Status
  • Example: Critical
  • Example: Info
• SNMP Trap: Web Certificate Expiry
• SNMP Trap: Security Updates
• SNMP Trap: Memory Usage
  • Example: Critical
  • Example: Info
• SNMP Trap: NTP Status
  • Example: Critical
  • Example: Urgent
  • Example: Urgent
• SNMP Trap: DNS status
  • Example: Urgent
• SNMP Trap: Domain Status
  • Example: Urgent
• SNMP Trap: NTP Offset
• SNMP Trap: Process Memory Threshold Status

VOSS-4-UC System Monitoring Traps

• SNMP Traps: System Monitoring
  • Transaction Queue Size
  • Transactions: Model Operations Alerts
  • Change Notification Feature (CNF)
  • Warning and Error Alert Codes
  • Session Limits
  • API Request Throttle
  • Total DB Index Size
  • Total DB Size
  • Device Communications Concurrency Limit
• Notification Messages

Scheduling

• Scheduling
• Internal Report Schedules

Backups

• 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
  • Restoring backup files too large for import
• VMware Snapshot Maintenance

Restoring a Backup on a New Environment

• Introduction to Restoring Backups on a New Environment
• Setting up the Backup Passphrase on a New Environment
• Adding More Space to Accommodate a Large Restore
• Reassign Current Drives (Backup and DBroot)
• Restore the Backup
• Example of a Successful Restore

System Security

• Security Overview
• Security Patches and Updates
• 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

Network Security

• Network Communications between Nodes within the Cluster
• Network Communications External to the Cluster
• Dynamic Firewall
• Web Certificate Setup Options
• VOSS-4-UC Setup a Web Certificate
• Own Web Certificate Setup
• Web Certificate Expiration Notice
  • Renewing Expired Certificates
• Convert Web Certificates from P7B to PEM Format
• Web Certificate Commands
• Web TLS Protocol Configuration
• Web TLS Cipher Management
• Network URI specification
• Web External Proxies

High Availability and Disaster Recovery (DR)

• 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 and Recovery Overview

• DR Failover
• Cluster Failure Scenarios
• Create a New VM Using the Platform-Install OVA
  • Notes on Passwords and Security
  • Notes on Multi-Node Installation
  • Finalize the Installation

DR Failover and Recovery in a Unified Node Cluster Topology

• 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 Primary Node
  • Recovery Steps
• Scenario: Loss of Full Cluster
  • Background
  • Full cluster failure
  • Recovery Steps

DR Failover and Recovery in a Modular Cluster Topology

• 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
  • Application Node Failure
  • Recovery steps
• Scenario: Loss of the Primary Database Server in a Modular Cluster
  • Database Node Failure
  • Recovery Steps
• Scenario: Loss of a non-primary database: Modular Cluster
  • Database Node Failure
  • Recovery steps
• Scenario: Loss of a Primary Site in a Modular Cluster
  • Primary site failure
  • Recovery Steps (two options):
• Scenario: Loss of a DR Site in a Modular Cluster
  • DR site failure
  • Recovery Steps
• Scenario: Loss of Full Cluster in a Modular Cluster
  • Background
  • Full cluster failure
  • Recovery Steps

Troubleshooting

• Platform User Password Recovery Procedure
• ‘No Space Left on Device’ Error
• Loss of the whole cluster and redeploying new servers
• Memory (RAM) Increase for Large End User Capacity
• Error Messages

Appendices

MIBs

• MIB List

Data Export Types

• 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
• Line Data Export
• Phones Data Export
• Site Data Export
• Subscriber Data Export
  • Hybrid System Subscriber Data Export
  • MS Office 365 Subscriber Data Export
  • MS Teams Subscriber Data Export
  • Pexip Subscriber Data Export
  • VOSS Phone Servers Subscriber Data Export
• Webex Teams Data Export

Command Examples

• diag Command Examples
  • diag disk
  • diag monitor
  • diag monitor list
  • diag nicstat
  • diag free
  • diag iostat
  • diag top
  • diag config platform
  • diag config app snmp
  • diag proc
  • diag stats
  • diag tasks
  • diag top
  • diag vmstat