A d m i n i s t r a t o r G u i d e Version 3.11.8 © 2022 Axiros GmbH All rights reserved. This guide contains proprietary information protected by copyright. This documentation is provided for informational purposes only. Axiros makes no warranties, either express or implied, with respect to the accuracy or completeness of the contents of this document. Information in this documentation, including URL and other Internet Web site references, is subject to change without notice. The entire risk of the use or the results of the use of this documentation remains with the user. All trademarks are property of their respective owners. Contact information: Axiros GmbH Altlaufstraße 34 85635 Munich Hoehenkirchen info@axiros.com www.axiros.com Chapter 1: Default Configuration Overview 21 ............................................................................................................... CFG Folder 23 ........................................................................................................................................................................... DeviceLib Folder 23 ................................................................................................................................................................. Chapter 2: Best Practices 24 ............................................................................................................................................... Changing Administrator Passwords 24 .............................................................................................................................. Configuring CPE Authentication 25 ..................................................................................................................................... HTTP Basic Authentication 25 .................................................................................................................................... HTTP Digest Authentication 26 ................................................................................................................................... Authentication Scenarios 27 ........................................................................................................................................ Changing Port Settings 27 ..................................................................................................................................................... Managing TR-069 Parameter Definition Files 28 ............................................................................................................. Updating Parameter Definition Files 28 .................................................................................................................... Adding Vendor-Specific Parameters 29 .................................................................................................................... Overwriting Parameter Types 31 ................................................................................................................................ Managing CPE Properties (Stored Params) 31 ...................................................................................................... Generating Parameter Definition Files from GPV Results 34 .............................................................................. Importing and Using Custom Code in ZODB scripts 36 ................................................................................................. Using OODBLogger 37 ............................................................................................................................................................ Installation 38 .................................................................................................................................................................. Exporting data 38 ............................................................................................................................................................ Best Practices 38 ............................................................................................................................................................ Monitoring AXESS.ACS via SNMP 39 .................................................................................................................................. SNMP Traps 39 ............................................................................................................................................................... Managing Tickets 43 ............................................................................................................................................................... Using Callback Proxy 44 ......................................................................................................................................................... AX-TicketHeader Configured 44 .................................................................................................................................. AXTicketHeader Not Configured 47 ........................................................................................................................... Installation 48 .................................................................................................................................................................. Configuration 48 .............................................................................................................................................................. Overwriting Timeout 49 ................................................................................................................................................. List of errors 49 ............................................................................................................................................................... Logs 50 .............................................................................................................................................................................. Working with a CPE Object 51 .............................................................................................................................................. Working with a Service Object 53 ........................................................................................................................................ Multi-step Scenario 54 ............................................................................................................................................................ Creating a Scenario 54 .................................................................................................................................................. Tickets 56 ................................................................................................................................................................................... Workflows 58 ............................................................................................................................................................................ Python Script 58 .............................................................................................................................................................. Scenario 60 ...................................................................................................................................................................... Randomizing the PeriodicInformTime 65 .......................................................................................................................... Encrypted MySQL Connection 65 ........................................................................................................................................ Chapter 3: Back Up and Recovery 67 ................................................................................................................................ Backing Up AXESS chroot 67 ................................................................................................................................................ Backing Up the Database 68 ................................................................................................................................................. Restoring AXESS.ACS 68 ....................................................................................................................................................... Chapter 4: Southbound CPE Handling 70 ........................................................................................................................ Default Job Handling 70 ......................................................................................................................................................... AX-TR069 Proxy 73 .................................................................................................................................................................. The processInform Script 74 ................................................................................................................................................ Custom Inform Handling 75 .................................................................................................................................................. Basic AXESS.ACS Objects 76 ................................................................................................................................................ CPE Object 76 .................................................................................................................................................................. Service 77 ......................................................................................................................................................................... Scenario 77 ....................................................................................................................................................................... Tickets 79 ......................................................................................................................................................................... Ticket Flows Overview 87 ...................................................................................................................................................... Generic TR-069 Flow 87 ................................................................................................................................................ Generic Master Flow 88 ................................................................................................................................................ Generic Job Management Flow 91 ............................................................................................................................ Reports 94 ........................................................................................................................................................................ Sample Scenarios 96 .............................................................................................................................................................. Simple multistep scenario 96 ...................................................................................................................................... Complex multistep scenario 97 ................................................................................................................................... Sample Ticket Flow 100 ......................................................................................................................................................... Integrating External Methods 101 ....................................................................................................................................... Chapter 5: AXCondition 103 ................................................................................................................................................. Operators 105 ........................................................................................................................................................................... Chapter 6: AXSchema 106 .................................................................................................................................................... Listable in axlib 114 ................................................................................................................................................................. Extending AXSchema 115 ...................................................................................................................................................... AXServiceStorage and MySQL Views 116 ......................................................................................................................... AXSchema automatic updates 117 ..................................................................................................................................... Chapter 7: AXGroup 118 ........................................................................................................................................................ AXGroup Additional Features 118 ........................................................................................................................................ Domain 118 ...................................................................................................................................................................... Consumed members 119 ............................................................................................................................................. Extended members 119 ................................................................................................................................................ Group Types 120 ...................................................................................................................................................................... Dynamic groups 120 ...................................................................................................................................................... Static groups 121 ........................................................................................................................................................... Lazy groups 122 .............................................................................................................................................................. Super groups 123 ........................................................................................................................................................... AXGroup MySQL Tables 124 ................................................................................................................................................. MySQL partitioning 124 ................................................................................................................................................. Group Schema 126 .................................................................................................................................................................. Built-in AXESS Schema 127 ......................................................................................................................................... Auto-generated Service Schema 127 ........................................................................................................................ Group Result List 128 ............................................................................................................................................................. Group Filter 128 ........................................................................................................................................................................ Operators 129 .................................................................................................................................................................. Logical Connectives 129 ............................................................................................................................................... Cache Settings 130 ................................................................................................................................................................. AXGroup API 131 ...................................................................................................................................................................... Chapter 8: Job Management 132 ....................................................................................................................................... Supported Features Overview 133 ....................................................................................................................................... Sequence Diagrams 135 ........................................................................................................................................................ Configuration 137 ..................................................................................................................................................................... Configuration Types 138 ............................................................................................................................................... Conditions 139 .......................................................................................................................................................................... Schedule 139 ............................................................................................................................................................................. How It Works 142 ..................................................................................................................................................................... AXJobManager Table 142 ............................................................................................................................................ How Passive Jobs Work - AXGroup Integration 143 ............................................................................................. How Passive Jobs Work - Order of Jobs 144 .......................................................................................................... How Active Jobs Work - AXGroup Integration 144 ................................................................................................ Order of Checks for Passive Jobs 146 ...................................................................................................................... Order of Checks for Active Campaigns 146 ............................................................................................................. Offline CPEs 146 ............................................................................................................................................................. Job Manager Behavior Specifics 147 ................................................................................................................................. Job Definitions 147 .................................................................................................................................................................. Parameters Configuration 150 .................................................................................................................................... Job Definitions API 152 ................................................................................................................................................. Context Management 153 ..................................................................................................................................................... Context enriched automatically 155 .......................................................................................................................... Context API 156 .............................................................................................................................................................. Job Templates 157 .................................................................................................................................................................. Scenario 157 .................................................................................................................................................................... Ticket 157 ......................................................................................................................................................................... Script 158 .......................................................................................................................................................................... Job Constraints 158 ....................................................................................................................................................... Job parametrization 158 ............................................................................................................................................... Job Results 159 ........................................................................................................................................................................ Tickets 159 ................................................................................................................................................................................ Ticket Flows 159 ............................................................................................................................................................. Ticket State 160 .............................................................................................................................................................. Custom Ticket Flow compliance 160 ........................................................................................................................ AXCampaigns MySQL Tables 161 ....................................................................................................................................... DB Structure 161 ............................................................................................................................................................. MySQL partitioning 162 ................................................................................................................................................. Counters 163 ............................................................................................................................................................................. AXPassiveJobsConfig 164 ..................................................................................................................................................... Examples 165 .................................................................................................................................................................. Chapter 9: AXAPI 168 ............................................................................................................................................................ AXESS Endpoints 168 ............................................................................................................................................................. Configure Tab 169 ................................................................................................................................................................... Operations 170 ......................................................................................................................................................................... Params 171 ...................................................................................................................................................................... List 180 .............................................................................................................................................................................. Count 186 ......................................................................................................................................................................... Create, Update and Delete 187 .................................................................................................................................... Read 189 ........................................................................................................................................................................... RPCs 190 .......................................................................................................................................................................... Response Format 190 ............................................................................................................................................................ Customizing the Response Using Formatters 191 ................................................................................................ Creating a New Type 199 ....................................................................................................................................................... Creating a New Endpoint 200 ............................................................................................................................................... Exposing a New Endpoint 201 .............................................................................................................................................. Role-Based Access Control in AXAPI 202 .......................................................................................................................... Working with Roles 203 ................................................................................................................................................ Customizing Default Endpoints 212 .................................................................................................................................... How To 212 ...................................................................................................................................................................... Configuring Alias for Default Endpoint 215 ....................................................................................................................... Integrating External API Calls 216 ....................................................................................................................................... REST 216 .......................................................................................................................................................................... SOAP 217 .......................................................................................................................................................................... Tickets 217 ....................................................................................................................................................................... AXAPI Quick Reference 218 .................................................................................................................................................. Using AXAPI for AXServiceStorage Operations 218 .............................................................................................. AXAPI Response Codes 218 ........................................................................................................................................ Full Reference 218 .......................................................................................................................................................... SQL to AXAPI Data Types Mapping 224 ................................................................................................................... Chapter 10: Service Storage 225 ........................................................................................................................................ Service Provisioning Flow 226 .............................................................................................................................................. Default Service Definitions 226 ............................................................................................................................................. HSI 227 .............................................................................................................................................................................. DHCP 228 ......................................................................................................................................................................... WIFI 229 ............................................................................................................................................................................ VOIP 230 ........................................................................................................................................................................... VOIPbyLineId 231 ............................................................................................................................................................ PORTMAPPING 232 ....................................................................................................................................................... Creating a Service Definition 232 ......................................................................................................................................... Deleting a Service Definition 236 ......................................................................................................................................... Service Actions 237 ................................................................................................................................................................. Testing Service Actions 237 ........................................................................................................................................ Provisioning Actions 239 .............................................................................................................................................. Informational Actions 255 ............................................................................................................................................ Technical Information 271 ........................................................................................................................................... Service Instances Overview 274 ........................................................................................................................................... Custom Ticket Flows 274 ...................................................................................................................................................... Setting Up an External System 275 ........................................................................................................................... Setting Up a Service on AXESS.ACS 276 .................................................................................................................. Architecture Overview 276 ............................................................................................................................................ Configuring the Custom Flow 277 .............................................................................................................................. Configuring a Custom NBI Handler 279 .................................................................................................................... API Reference for the NBI 280 .............................................................................................................................................. AXServiceStorage Schema Migration 281 ......................................................................................................................... Analyzing Existing Service Definitions 281 ............................................................................................................... Writing the New Service Schema 283 ....................................................................................................................... Validating the New Service Schema 285 .................................................................................................................. Migrating Services and Definitions in MySQL 285 ................................................................................................. AXServiceStorage Native Integer Support 286 ................................................................................................................. Migrating Service Schema 286 ................................................................................................................................... Setting Native Integer Columns 286 .......................................................................................................................... Range Queries Without Native Integer Support 287 .............................................................................................. Chapter 11: Policy Manager 288 ........................................................................................................................................ Policies Overview 288 ............................................................................................................................................................. Default Policies 289 ................................................................................................................................................................. Initialize CPE after FactoryReset 289 ........................................................................................................................ Backup of Configuration File 289 ............................................................................................................................... Managing Policies 289 ............................................................................................................................................................ Policy Statistics 291 ................................................................................................................................................................ Specific Config 291 .................................................................................................................................................................. Chapter 12: User Account Management 292 .................................................................................................................. Creating User Accounts 293 ................................................................................................................................................. Updating User Accounts 293 ................................................................................................................................................ Deleting User Accounts 294 .................................................................................................................................................. Configuring Authenticators 295 ........................................................................................................................................... Configuring Password Policy 296 ............................................................................................................................... Custom Authenticators and Roles 296 ............................................................................................................................... Enabling JWT for Authentication 298 ................................................................................................................................. JWT Usage 300 ........................................................................................................................................................................ AXChart Usage 300 ........................................................................................................................................................ API Usage 301 ................................................................................................................................................................. Single Sign On with Apache mod_auth_openidc 301 ...................................................................................................... Installation 302 ................................................................................................................................................................ Configuration 302 ........................................................................................................................................................... Authentication Flow 303 ............................................................................................................................................... Chapter 13: Configuration Storage 304 ............................................................................................................................ Configuration File Structure 304 .......................................................................................................................................... Backing Up and Restoring Configuration Files 305 ......................................................................................................... Security and Authentication 305 ................................................................................................................................. Examples 306 .................................................................................................................................................................. Managing Configuration Files 309 ....................................................................................................................................... AXConfigStorage API 311 ...................................................................................................................................................... Chapter 14: Process Manager 312 ..................................................................................................................................... Creating and Managing Processes 312 ............................................................................................................................. Adding a Process 320 .................................................................................................................................................... Managing Processes 321 ............................................................................................................................................. Chapter 15: Grafana 323 ....................................................................................................................................................... Installing and Configuring Grafana 323 ...........................................