Platform Guide ############## .. toctree:: /src/user/src-user-platform-index-whatsnew -------- Overview -------- .. toctree:: /src/user/platform/concepts-install-overview -------------------------- The Command Line Interface -------------------------- .. toctree:: /src/user/cli/concepts-cli /src/user/cli/concepts-cli-commands /src/user/platform/reference-screen-command System Specific Commands ======================== .. toctree:: /src/user/platform/reference-voss-commands /src/user/platform/reference-voss-commands-install /src/user/platform/reference-voss-commands-db /src/user/platform/reference-voss-commands-transactions-db /src/user/platform/reference-voss-commands-performance /src/user/platform/reference-voss-commands-system /src/user/best-practices/best-prac-archiving-transactions-steps System Metrics ============== .. toctree:: /src/user/platform/reference-voss-commands-system-metrics-transactions /src/user/platform/reference-voss-commands-system-metrics-api Data Export Commands ==================== .. toctree:: /src/user/platform/reference-data-export-overview /src/user/platform/reference-data-export-command-subscriber --------------- Node Deployment --------------- .. toctree:: /src/user/platform/concepts-deployment /src/user/install/concepts-modular-deployment-topology /src/user/platform/tasks-deployment-migrate-to-modular /src/user/platform/concepts-cluster-primary-role ------------ Provisioning ------------ .. toctree:: /src/user/platform/concepts-provisioning ---------- Networking ---------- .. toctree:: /src/user/platform/reference-network-interfaces /src/user/platform/reference-network-services /src/user/platform/reference-network-URI-spec /src/user/platform/reference-network-container ------------------- Application Control ------------------- .. toctree:: /src/user/platform/concepts-app-control /src/user/platform/reference-app-start-stop /src/user/platform/concepts-app-install /src/user/platform/concepts-app-upgrade /src/user/platform/concepts-summary-attr-migration /src/user/platform/concepts-remote-exec-clusters /src/user/platform/reference-list-of-unused-cluster-commands /src/user/platform/reference-selfservice-localization-mgt /src/user/platform/reference-web-service-enable-disable -------------- System Control -------------- .. toctree:: /src/user/platform/concepts-system /src/user/platform/reference-system-restart /src/user/platform/reference-system-passwords /src/user/platform/reference-system-boot-passwords /src/user/platform/reference-system-FIPS /src/user/platform/reference-system-file-mgt /src/user/platform/reference-system-drive-control /src/user/operations/concepts-transaction-prioritization /src/user/platform/reference-system-banner /src/user/platform/reference-sha256sum ----------- Diagnostics ----------- .. toctree:: /src/user/platform/reference-health-banner /src/user/platform/reference-cluster-check /src/user/platform/tasks-enable-health-monitor /src/user/platform/tasks-enable-database-schedule /src/user/platform/reference-command-history /src/user/platform/reference-logs /src/user/platform/reference-view-logs /src/user/platform/reference-gather-logs /src/user/platform/reference-logs-types /src/user/platform/reference-logs-audit-ruleset /src/user/platform/reference-log-type-commands /src/user/platform/reference-logs-audit-format /src/user/platform/reference-logs-event-format /src/user/platform/reference-log-streaming /src/user/platform/reference-logs-remote-encryption /src/user/platform/reference-mail /src/user/platform/reference-tools /src/user/platform/reference-diagnostic-troubleshooting ------------- Notifications ------------- .. toctree:: /src/user/platform/reference-warnings-notifications /src/user/platform/events-and-snmp-messages /src/user/platform/reference-SNMP-queries ---- SNMP ---- .. toctree:: /src/user/platform/snmp/concepts-SNMP-MIBS-Intro /src/user/platform/snmp/concepts-SNMP-Traps /src/user/platform/snmp/concepts-Management-Information-Bases MIB and Trap Details ==================== .. toctree:: /src/user/platform/snmp/reference-SNMPv2-MIB-RFC3418 /src/user/platform/snmp/reference-IF-MIB-RFC2863 /src/user/platform/snmp/reference-MIB-II-RFC1213 /src/user/platform/snmp/reference-IP-MIB-RFC4293 /src/user/platform/snmp/reference-TCP-MIB-RFC4022 /src/user/platform/snmp/reference-UDP-MIB-RFC4113 /src/user/platform/snmp/reference-HOST-RESOURCES-MIB-RFC2790 /src/user/platform/snmp/reference-SNMP-Traps-System-Startup /src/user/platform/snmp/reference-SNMP-Traps-Service-Startup-changes-made /src/user/platform/snmp/reference-SNMP-Traps-Service-Monitoring-changes-made /src/user/platform/snmp/reference-SNMP-Traps-Service-Status /src/user/platform/snmp/reference-SNMP-Traps-System-Shutdown /src/user/platform/snmp/reference-SNMP-Trap-Disk-Full /src/user/platform/snmp/reference-SNMP-Trap-Database-Usage /src/user/platform/snmp/reference-SNMP-Trap-Database-Maintenance /src/user/platform/snmp/reference-SNMP-Trap-Excessive-Load /src/user/platform/snmp/reference-SNMP-Trap-Backup /src/user/platform/snmp/reference-SNMP-Trap-Health-emails /src/user/platform/snmp/reference-SNMP-Trap-Disk-Latency /src/user/platform/snmp/reference-SNMP-Trap-Mailbox-status /src/user/platform/snmp/reference-SNMP-Trap-Cluster-status /src/user/platform/snmp/reference-SNMP-Trap-db-failover-status /src/user/platform/snmp/reference-SNMP-Trap-Large-log-files /src/user/platform/snmp/reference-SNMP-Trap-Network-status /src/user/platform/snmp/reference-SNMP-Trap-NGINX-status /src/user/platform/snmp/reference-SNMP-Trap-Web-Cert-Expire /src/user/platform/snmp/reference-SNMP-Trap-Security-updates /src/user/platform/snmp/reference-SNMP-Trap-Memory-usage /src/user/platform/snmp/reference-SNMP-Trap-NTP-status /src/user/platform/snmp/reference-SNMP-Trap-DNS-status /src/user/platform/snmp/reference-SNMP-Trap-Domain-status /src/user/platform/snmp/reference-SNMP-Trap-NTP-offset /src/user/platform/snmp/reference-SNMP-Trap-Process-Memory-threshold-Status VOSS-4-UC System Monitoring Traps ================================= .. toctree:: /src/user/platform/snmp/reference-SNMP-Traps-System-Monitoring /src/user/platform/reference-notification-messages ---------- Scheduling ---------- .. toctree:: /src/user/platform/reference-scheduling /src/user/platform/reference-scheduling-internal ------- Backups ------- .. toctree:: /src/user/platform/concepts-backups /src/user/platform/concepts-backup-restore-scalable-arch /src/user/platform/reference-backup-destinations /src/user/platform/reference-backup-passphrase /src/user/platform/reference-backup-size /src/user/platform/reference-backup-create /src/user/platform/reference-cluster-backup-restore /src/user/platform/tasks-backup-restore-space /src/user/platform/reference-backup-maintain /src/user/platform/tasks-backup-import-new-environment /src/user/platform/concepts-VMWare-snapshot-maintenance Restoring a Backup on a New Environment ======================================= .. toctree:: /src/user/platform/concepts-backup-restore-new-env-intro /src/user/platform/tasks-backup-restore-new-backup-passphrase /src/user/platform/tasks-backup-restore-new-add-more-space-large-restore /src/user/platform/tasks-backup-restore-new-reassign-current-drives /src/user/platform/tasks-backup-restore-new-restore /src/user/platform/reference-backup-restore-new-successful-restore-example --------------- System Security --------------- .. toctree:: /src/user/platform/security/concepts-security-intro /src/user/platform/security/concepts-security-system-patches-updates /src/user/platform/security/concepts-security-system-configuration-encryption /src/user/platform/security/concepts-security-system-backup-encryption /src/user/platform/security/concepts-security-system-app-install-files-encryption /src/user/platform/security/concepts-security-file-integrity /src/user/platform/security/concepts-security-system-protected-app-environments /src/user/platform/security/concepts-security-system-restricted-user-shell /src/user/platform/security/concepts-security-user-security-policy /src/user/platform/security/concepts-security-system-creating-additional-users /src/user/platform/security/concepts-security-system-creating-SFTP-users /src/user/platform/security/concepts-security-system-granting-revoking-user-rights /src/user/platform/security/concepts-security-system-password-strength-rules /src/user/platform/security/concepts-security-login-fail-limit /src/user/platform/security/concepts-security-SSH-session-limit /src/user/platform/security/concepts-security-SSH-key-management /src/user/platform/security/concepts-security-SSH-algorithm-management /src/user/platform/security/concepts-security-user-auto-login /src/user/platform/security/concepts-security-network-prevention-DOS-attacks /src/user/platform/security/concepts-security-memory-dumps /src/user/platform/reference-database-users-manage ---------------- Network Security ---------------- .. toctree:: /src/user/platform/reference-network-comms-in-cluster /src/user/platform/reference-network-comms-outside-cluster /src/user/platform/security/concepts-security-network-dynamic-firewall /src/user/platform/security/concepts-security-network-web-certificates /src/user/platform/security/tasks-security-network-web-certificates /src/user/platform/security/tasks-security-network-own-certificate-setup /src/user/platform/security/concepts-web-cert-expire /src/user/platform/security/tasks-security-network-web-certificates-p7b-to-pem /src/user/platform/security/reference-web-cert-commands /src/user/platform/security/reference-web-configure-ssl-level /src/user/platform/security/concepts-security-web-TLS-cipher-management /src/user/platform/concepts-platform5-reference-URI-specification /src/user/platform/reference-web-remote-server-proxy -------------------------------------------- High Availability and Disaster Recovery (DR) -------------------------------------------- .. toctree:: :maxdepth: 2 /src/user/operations/concepts-HA-overview /src/user/operations/concepts-default-HA-DR-scenario /src/user/operations/concepts-default-HA-DR-scenario-Cisco-VMDC /src/user/operations/tasks-configure-HA-on-VMWare DR Failover and Recovery Overview =============================================== .. toctree:: :maxdepth: 2 /src/user/operations/tasks-DR-failover /src/user/install/concepts-cluster-failure-scenarios /src/user/install/install-details DR Failover and Recovery in a Unified Node Cluster Topology ============================================================= .. toctree:: :maxdepth: 2 /src/user/operations/reference-DR-failover-recovery-voting /src/user/operations/reference-DR-failover-recovery /src/user/operations/reference-DR-failover-power-off-recovery-sc /src/user/operations/reference-DR-failover-recovery-sc1 /src/user/operations/reference-DR-failover-recovery-sc2 /src/user/operations/reference-DR-failover-recovery-sc3 /src/user/operations/reference-DR-failover-recovery-sc4 /src/user/operations/reference-DR-failover-recovery-sc5 /src/user/operations/reference-DR-failover-recovery-2-node /src/user/operations/reference-DR-failover-recovery-sc6 DR Failover and Recovery in a Modular Cluster Topology ====================================================== .. toctree:: :maxdepth: 2 /src/user/operations/reference-DR-failover-recovery-voting-modular /src/user/operations/reference-DR-failover-recovery-modular /src/user/operations/reference-DR-failover-power-off-recovery-modular-sc /src/user/operations/reference-DR-failover-recovery-modular-sc1 /src/user/operations/reference-DR-failover-recovery-modular-sc3-db /src/user/operations/reference-DR-failover-recovery-modular-sc2 /src/user/operations/reference-DR-failover-recovery-modular-sc4 /src/user/operations/reference-DR-failover-recovery-modular-sc5 /src/user/operations/reference-DR-failover-recovery-modular-sc6 --------------- Troubleshooting --------------- .. toctree:: :maxdepth: 2 /src/user/platform/security/tasks-security-platform-password-recovery /src/user/operations/no_space_left_on_device_error /src/user/platform/reference-cluster-backup-restore-lost-cluster /src/user/operations/reference-memory-upgrade /src/user/operations/reference-error-codes ---------- Appendices ---------- .. toctree:: MIBs ==== .. toctree:: /src/user/platform/snmp/reference-MIBs Data Export Types ================= .. toctree:: /src/user/platform/reference-data-export-analogue_line_mgcp /src/user/platform/reference-data-export-analogue_line_sccp /src/user/platform/reference-data-export-call_pickup_group /src/user/platform/reference-data-export-contact-center-enterprise /src/user/platform/reference-data-export-contact-center-express /src/user/platform/reference-data-export-customer /src/user/platform/reference-data-export-extension_mobility /src/user/platform/reference-data-export-fmc /src/user/platform/reference-data-export-hunt_group /src/user/platform/reference-data-export-line /src/user/platform/reference-data-export-phones /src/user/platform/reference-data-export-site /src/user/platform/reference-data-export-subscriber /src/user/platform/reference-data-export-webex-teams Command Examples =================== .. toctree:: /src/user/platform/reference-diag-command-examples .. |VOSS-4-UC| replace:: VOSS-4-UC .. |Unified CM| replace:: Unified CM