├── README.md ├── zbx_tmplt_pbs.yaml └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # Zabbix template for Proxmox Backup Server monitoring 2 | 3 | - [Zabbix template for Proxmox Backup Server monitoring](#zabbix-template-for-proxmox-backup-server-monitoring) 4 | - [Macros](#macros) 5 | - [Items](#items) 6 | - [Triggers](#triggers) 7 | - [Autodiscovery](#autodiscovery) 8 | - [Item prototypes](#item-prototypes) 9 | - [Trigger prototypes](#trigger-prototypes) 10 | - [Usage](#usage) 11 | 12 | Tested on Zabbix 6.0.7 and Proxmox Backup Server 2.2 13 | 14 | ## Macros 15 | 16 | | Macro | Default value | Description | 17 | | ------------------------------ | -------------------------------------- | ---------------------------------------------------------------------------------------------------------- | 18 | | `{$PBS.NODE.NAME}` | `pbs` | Node name of PBS. Needed system info (CPU/RAM, etc of PBS server) | 19 | | `{$PBS.TOKEN.ID}` | `USER@REALM!TOKENID` | API tokens allow stateless access to most parts of the REST API by another system, software or API client. | 20 | | `{$PBS.TOKEN.SECRET}` | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Secret key. | 21 | | `{$PBS.URL.PORT}` | `8007` | The API uses the HTTPS protocol and the server listens to port 8007 by default. | 22 | | `{$PBS.CPU.PUSE.MAX.WARN}` | `90` | Maximum used CPU in percentage. | 23 | | `{$PBS.MEMORY.PUSE.MAX.WARN}` | `90` | Maximum used memory in percentage. | 24 | | `{$PBS.SWAP.PUSE.MAX.WARN}` | `90` | Maximum used swap in percentage. | 25 | | `{$PBS.ROOT.PUSE.MAX.WARN}` | `90` | Maximum used root space in percentage. | 26 | | `{$PBS.STORAGE.PUSE.MAX.WARN}` | `90` | Maximum used storage space in percentage. | 27 | 28 | ## Items 29 | 30 | | Name | Key | Type | Description | 31 | | ---------------------------------------- | ----------------------------------- | ----------------------------------- | --------------------------------------- | 32 | | PBS: API Ping | `pbs.ping` | HTTP agent | Api availability | 33 | | PBS: Datastores usage | `pbs.status.datastore-usage` | HTTP agent | Datasource info and status | 34 | | PBS: Node status | `pbs.node.status` | HTTP agent | Node info and status | 35 | | PBS: Failed tasks | `pbs.tasks.failed` | HTTP agent | Failed tasks for all time | 36 | | PBS: Failed backup tasks count | `pbs.tasks.failed.count_backup` | Dependent (from `pbs.tasks.failed`) | Failed backup tasks count | 37 | | PBS: Last failed backup task | `pbs.tasks.failed.last_backup` | Dependent (from `pbs.tasks.failed`) | Last failed backup task data | 38 | | PBS: Last failed backup task time | `pbs.tasks.failed.last_backup_time` | Dependent (from `pbs.tasks.failed`) | Last failed backup task time (unixtime) | 39 | | PBS: Version | `pbs.version` | HTTP agent | PBS Version | 40 | | PBS: Node status: PBS Node: cpu usage | `pbs.node.cpu` | Dependent (from `pbs.node.status`) | Node CPU Usage in percent | 41 | | PBS: Node status: PBS Node: kernel | `pbs.node.kversion` | Dependent (from `pbs.node.status`) | Node kernel version | 42 | | PBS: Node status: PBS Node: kernel | `pbs.node.kversion` | Dependent (from `pbs.node.status`) | Node kernel version | 43 | | PBS: Node status: PBS Node: memory | `pbs.node.memory` | Dependent (from `pbs.node.status`) | Node memory info | 44 | | PBS Node: memory: PBS Node: memory free | `pbs.node.memory.free` | Dependent (from `pbs.node.memory`) | Free memory in bytes | 45 | | PBS Node: memory: PBS Node: memory total | `pbs.node.memory.total` | Dependent (from `pbs.node.memory`) | Total memory in bytes | 46 | | PBS Node: memory: PBS Node: memory used | `pbs.node.memory.used` | Dependent (from `pbs.node.memory`) | Used memory in bytes | 47 | | PBS Node: memory used percent | `pbs.node.memory.pused` | Calculated | Used memory in percent | 48 | | PBS: Node status: PBS Node: swap | `pbs.node.swap` | Dependent (from `pbs.node.status`) | Node swap info | 49 | | PBS Node: swap: PBS Node: swap free | `pbs.node.swap.free` | Dependent (from `pbs.node.swap`) | Free swap in bytes | 50 | | PBS Node: swap: PBS Node: swap total | `pbs.node.swap.total` | Dependent (from `pbs.node.swap`) | Total swap in bytes | 51 | | PBS Node: swap: PBS Node: swap used | `pbs.node.swap.used` | Dependent (from `pbs.node.swap`) | Used swap in bytes | 52 | | PBS Node: swap used percent | `pbs.node.swap.pused` | Calculated | Used swap in percent | 53 | | PBS: Node status: PBS Node: root | `pbs.node.root` | Dependent (from `pbs.node.status`) | Node root info | 54 | | PBS Node: root: PBS Node: root avail | `pbs.node.root.avail` | Dependent (from `pbs.node.root`) | Free root in bytes | 55 | | PBS Node: root: PBS Node: root total | `pbs.node.root.total` | Dependent (from `pbs.node.root`) | Total root in bytes | 56 | | PBS Node: root: PBS Node: root used | `pbs.node.root.used` | Dependent (from `pbs.node.root`) | Used root in bytes | 57 | | PBS Node: root used percent | `pbs.node.root.pused` | Calculated | Used root in percent | 58 | | PBS: Node status: PBS Node: uptime | `pbs.node.uptime` | Dependent (from `pbs.node.status`) | Node uptime in seconds | 59 | 60 | ## Triggers 61 | 62 | | Name | Severity | Description | 63 | | ------------------------------ | -------- | ----------------------------------------------------- | 64 | | PBS: API service not available | High | PBS Api is unavailable | 65 | | PBS: New failed backup task | Average | New failed backup task since last 24h | 66 | | PBS: Node high cpu usage | Average | High cpu usage (> `{$PBS.STORAGE.PUSE.MAX.WARN}` %) | 67 | | PBS: Node high memory usage | Average | High memory usage (> `{$PBS.MEMORY.PUSE.MAX.WARN}` %) | 68 | | PBS: Node high swap usage | Average | High swap usage (> `{$PBS.SWAP.PUSE.MAX.WARN}` %) | 69 | | PBS: Node high root usage | Average | High root usage (> `{$PBS.ROOT.PUSE.MAX.WARN}` %) | 70 | 71 | ## Autodiscovery 72 | 73 | ### Item prototypes 74 | 75 | | Name | Key | Type | Description | 76 | | -------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------- | -------------------------- | 77 | | PBS: Datastores usage: PBS Datastore: {#DATASTORE} | `pbs.datastore[{#DATASTORE}]` | Dependent (from `pbs.status.datastore-usage`) | Datasource info and status | 78 | | PBS Datastore: {#DATASTORE}: PBS Datastore: {#DATASTORE} avail | `pbs.datastore.avail[{#DATASTORE}]` | Dependent (from `pbs.datastore[{#DATASTORE}]`) | Free space in bytes | 79 | | PBS Datastore: {#DATASTORE}: PBS Datastore: {#DATASTORE} total | `pbs.datastore.total[{#DATASTORE}]` | Dependent (from `pbs.datastore[{#DATASTORE}]`) | Total space in bytes | 80 | | PBS Datastore: {#DATASTORE}: PBS Datastore: {#DATASTORE} used | `pbs.datastore.used[{#DATASTORE}]` | Dependent (from `pbs.datastore[{#DATASTORE}]`) | Used space in bytes | 81 | | PBS Datastore: {#DATASTORE} used percent | `pbs.datastore.pused[{#DATASTORE}]` | Calculated | Used space in percent | 82 | 83 | ### Trigger prototypes 84 | 85 | | Name | Severity | Description | 86 | | -------------------------------------- | -------- | --------------------------------------------------------- | 87 | | PBS Datastore: {#DATASTORE} high usage | Average | High datastore usage (> `{$PBS.STORAGE.PUSE.MAX.WARN}` %) | 88 | 89 | ## Usage 90 | 91 | - Issue new token in Configuraion -> Access Control -> API Token 92 | - Add API Token permission `Audit` to `/datastore`, `/system/status` and `/system/tasks` in Configuraion -> Access Control -> Permissions (Please note that the user on whose behalf the token is issued must have the appropriate rights) 93 | - Import `zbx_tmplt_pbs.yaml` to Zabbix 94 | - Attach new template `Proxmox Backup Server by HTTP` to host 95 | - Configure macros: 96 | - `{$PBS.NODE.NAME}` 97 | - `{$PBS.TOKEN.ID}` 98 | - `{$PBS.TOKEN.SECRET}` 99 | -------------------------------------------------------------------------------- /zbx_tmplt_pbs.yaml: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2022 Mikhail Isaev 2 | # Copyright (C) 2022 Andrey Gerasimov 3 | zabbix_export: 4 | version: '6.0' 5 | date: '2022-08-30T17:36:24Z' 6 | groups: 7 | - 8 | uuid: 846977d1dfed4968bc5f8bdb363285bc 9 | name: 'Templates/Operating systems' 10 | templates: 11 | - 12 | uuid: 9425adf0d5f94665be22c664e44436a1 13 | template: 'Proxmox Backup Server by HTTP' 14 | name: 'Proxmox Backup Server by HTTP' 15 | groups: 16 | - 17 | name: 'Templates/Operating systems' 18 | items: 19 | - 20 | uuid: ae7ca37e4eac43b1b268c32a17a6be4b 21 | name: 'PBS Node: cpu usage' 22 | type: DEPENDENT 23 | key: pbs.node.cpu 24 | delay: '0' 25 | value_type: FLOAT 26 | units: '%' 27 | preprocessing: 28 | - 29 | type: JSONPATH 30 | parameters: 31 | - $.cpu 32 | - 33 | type: MULTIPLIER 34 | parameters: 35 | - '100' 36 | master_item: 37 | key: pbs.node.status 38 | triggers: 39 | - 40 | uuid: 2d1602a3362f44b6954f3bd9c7bfd962 41 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.node.cpu)>{$PBS.CPU.PUSE.MAX.WARN}' 42 | name: 'PBS: Node high cpu usage' 43 | event_name: 'PBS: Node high cpu usage (over {$PBS.CPU.PUSE.MAX.WARN} use)' 44 | opdata: 'Current use: {ITEM.LASTVALUE1} of {ITEM.LASTVALUE2}' 45 | priority: AVERAGE 46 | description: 'CPU usage.' 47 | - 48 | uuid: 51fbd1f12daf48d0bd1846da8ba90219 49 | name: 'PBS Node: kernel' 50 | type: DEPENDENT 51 | key: pbs.node.kversion 52 | delay: '0' 53 | trends: '0' 54 | value_type: TEXT 55 | preprocessing: 56 | - 57 | type: JSONPATH 58 | parameters: 59 | - $.kversion 60 | master_item: 61 | key: pbs.node.status 62 | - 63 | uuid: b40813589f654e70a9c0c69dc466c387 64 | name: 'PBS Node: memory' 65 | type: DEPENDENT 66 | key: pbs.node.memory 67 | delay: '0' 68 | history: '0' 69 | trends: '0' 70 | value_type: TEXT 71 | preprocessing: 72 | - 73 | type: JSONPATH 74 | parameters: 75 | - $.memory 76 | master_item: 77 | key: pbs.node.status 78 | - 79 | uuid: 85121a08338f47dbb7ec1c16bec23fc4 80 | name: 'PBS Node: memory free' 81 | type: DEPENDENT 82 | key: pbs.node.memory.free 83 | delay: '0' 84 | units: B 85 | preprocessing: 86 | - 87 | type: JSONPATH 88 | parameters: 89 | - $.free 90 | master_item: 91 | key: pbs.node.memory 92 | - 93 | uuid: 7a86d826905f4a299a98abdb17cccb34 94 | name: 'PBS Node: memory used percent' 95 | type: CALCULATED 96 | key: pbs.node.memory.pused 97 | value_type: FLOAT 98 | units: '%' 99 | params: 'last(//pbs.node.memory.used) / last(//pbs.node.memory.total) * 100' 100 | triggers: 101 | - 102 | uuid: e3ae96b7f05c477fbe2cb81b43f518f1 103 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.node.memory.pused)>{$PBS.MEMORY.PUSE.MAX.WARN}' 104 | name: 'PBS: Node high memory usage' 105 | event_name: 'PBS: Node high memory usage (over {$PBS.MEMORY.PUSE.MAX.WARN} use)' 106 | opdata: 'Current use: {ITEM.LASTVALUE1} of {ITEM.LASTVALUE2}' 107 | priority: AVERAGE 108 | description: 'Memory usage.' 109 | - 110 | uuid: 57f245f277cc4a58bf6ab5321da7c0f5 111 | name: 'PBS Node: memory total' 112 | type: DEPENDENT 113 | key: pbs.node.memory.total 114 | delay: '0' 115 | units: B 116 | preprocessing: 117 | - 118 | type: JSONPATH 119 | parameters: 120 | - $.total 121 | master_item: 122 | key: pbs.node.memory 123 | - 124 | uuid: c4b7c5aa989d423e9dc52402207dfd74 125 | name: 'PBS Node: memory used' 126 | type: DEPENDENT 127 | key: pbs.node.memory.used 128 | delay: '0' 129 | units: B 130 | preprocessing: 131 | - 132 | type: JSONPATH 133 | parameters: 134 | - $.used 135 | master_item: 136 | key: pbs.node.memory 137 | - 138 | uuid: 398d3fda389846008de4e34fe96cd6d0 139 | name: 'PBS Node: root' 140 | type: DEPENDENT 141 | key: pbs.node.root 142 | delay: '0' 143 | history: '0' 144 | trends: '0' 145 | value_type: TEXT 146 | preprocessing: 147 | - 148 | type: JSONPATH 149 | parameters: 150 | - $.root 151 | master_item: 152 | key: pbs.node.status 153 | - 154 | uuid: eb6d21cf67fe4fdaab78f91f08c21fdf 155 | name: 'PBS Node: root avail' 156 | type: DEPENDENT 157 | key: pbs.node.root.avail 158 | delay: '0' 159 | units: B 160 | preprocessing: 161 | - 162 | type: JSONPATH 163 | parameters: 164 | - $.avail 165 | master_item: 166 | key: pbs.node.root 167 | - 168 | uuid: fc96b48841fe4829bd2975def7716b66 169 | name: 'PBS Node: root used percent' 170 | type: CALCULATED 171 | key: pbs.node.root.pused 172 | value_type: FLOAT 173 | units: '%' 174 | params: 'last(//pbs.node.root.used) / last(//pbs.node.root.total) * 100' 175 | triggers: 176 | - 177 | uuid: d06e1b95500e46f8b239b8db01c7dad0 178 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.node.root.pused)>{$PBS.ROOT.PUSE.MAX.WARN}' 179 | name: 'PBS: Node high root usage' 180 | event_name: 'PBS: Node high root usage (over {$PBS.ROOT.PUSE.MAX.WARN} use)' 181 | opdata: 'Current use: {ITEM.LASTVALUE1} of {ITEM.LASTVALUE2}' 182 | priority: AVERAGE 183 | description: 'Root usage.' 184 | - 185 | uuid: 95f26e06418845699c36015eb37fd580 186 | name: 'PBS Node: root total' 187 | type: DEPENDENT 188 | key: pbs.node.root.total 189 | delay: '0' 190 | units: B 191 | preprocessing: 192 | - 193 | type: JSONPATH 194 | parameters: 195 | - $.total 196 | master_item: 197 | key: pbs.node.root 198 | - 199 | uuid: 86847b6a6f9447859a9e3a1063f5bbc4 200 | name: 'PBS Node: root used' 201 | type: DEPENDENT 202 | key: pbs.node.root.used 203 | delay: '0' 204 | units: B 205 | preprocessing: 206 | - 207 | type: JSONPATH 208 | parameters: 209 | - $.used 210 | master_item: 211 | key: pbs.node.root 212 | - 213 | uuid: deb6c3d89d4d4e61ab31e43d87fac71d 214 | name: 'PBS: Node status' 215 | type: HTTP_AGENT 216 | key: pbs.node.status 217 | history: '0' 218 | trends: '0' 219 | value_type: TEXT 220 | preprocessing: 221 | - 222 | type: JSONPATH 223 | parameters: 224 | - $.data 225 | timeout: 10s 226 | url: 'https://{HOST.CONN}:{$PBS.URL.PORT}/api2/json/nodes/{$PBS.NODE.NAME}/status' 227 | headers: 228 | - 229 | name: Authorization 230 | value: 'PBSAPIToken={$PBS.TOKEN.ID}:{$PBS.TOKEN.SECRET}' 231 | - 232 | uuid: 392447742470439fa79ad4e2e211015e 233 | name: 'PBS Node: swap' 234 | type: DEPENDENT 235 | key: pbs.node.swap 236 | delay: '0' 237 | history: '0' 238 | trends: '0' 239 | value_type: TEXT 240 | preprocessing: 241 | - 242 | type: JSONPATH 243 | parameters: 244 | - $.swap 245 | master_item: 246 | key: pbs.node.status 247 | - 248 | uuid: ab2889a7ec654e9e924c065d1883dc25 249 | name: 'PBS Node: swap free' 250 | type: DEPENDENT 251 | key: pbs.node.swap.free 252 | delay: '0' 253 | units: B 254 | preprocessing: 255 | - 256 | type: JSONPATH 257 | parameters: 258 | - $.free 259 | master_item: 260 | key: pbs.node.swap 261 | - 262 | uuid: 0466ecb2b1bd467b91a1fbaf17d0911e 263 | name: 'PBS Node: swap used percent' 264 | type: CALCULATED 265 | key: pbs.node.swap.pused 266 | value_type: FLOAT 267 | units: '%' 268 | params: 'last(//pbs.node.swap.used) / last(//pbs.node.swap.total) * 100' 269 | triggers: 270 | - 271 | uuid: 4d70f270e7fe4bc783fea9c3aa4a5030 272 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.node.swap.pused)>{$PBS.SWAP.PUSE.MAX.WARN}' 273 | name: 'PBS: Node high swap usage' 274 | event_name: 'PBS: Node high swap usage (over {$PBS.SWAP.PUSE.MAX.WARN} use)' 275 | opdata: 'Current use: {ITEM.LASTVALUE1} of {ITEM.LASTVALUE2}' 276 | priority: AVERAGE 277 | description: 'Swap usage.' 278 | - 279 | uuid: a5f91341b3cc4057a13479945ec5934a 280 | name: 'PBS Node: swap total' 281 | type: DEPENDENT 282 | key: pbs.node.swap.total 283 | delay: '0' 284 | units: B 285 | preprocessing: 286 | - 287 | type: JSONPATH 288 | parameters: 289 | - $.total 290 | master_item: 291 | key: pbs.node.swap 292 | - 293 | uuid: b0f71283d40a4689b3ffbf4540dd04f9 294 | name: 'PBS Node: swap used' 295 | type: DEPENDENT 296 | key: pbs.node.swap.used 297 | delay: '0' 298 | units: B 299 | preprocessing: 300 | - 301 | type: JSONPATH 302 | parameters: 303 | - $.used 304 | master_item: 305 | key: pbs.node.swap 306 | - 307 | uuid: 56b079305d7f4a77a771c7c74693a6eb 308 | name: 'PBS Node: uptime' 309 | type: DEPENDENT 310 | key: pbs.node.uptime 311 | delay: '0' 312 | units: s 313 | preprocessing: 314 | - 315 | type: JSONPATH 316 | parameters: 317 | - $.uptime 318 | master_item: 319 | key: pbs.node.status 320 | - 321 | uuid: 90cc08574a0f4e53af9a4d01300abe7d 322 | name: 'PBS: API Ping' 323 | type: HTTP_AGENT 324 | key: pbs.ping 325 | trends: '0' 326 | value_type: TEXT 327 | preprocessing: 328 | - 329 | type: JSONPATH 330 | parameters: 331 | - $.data.pong 332 | - 333 | type: BOOL_TO_DECIMAL 334 | parameters: 335 | - '' 336 | timeout: 30s 337 | url: 'https://{HOST.CONN}:{$PBS.URL.PORT}/api2/json/ping' 338 | headers: 339 | - 340 | name: Authorization 341 | value: 'PBSAPIToken={$PBS.TOKEN.ID}:{$PBS.TOKEN.SECRET}' 342 | triggers: 343 | - 344 | uuid: 8fb708f211ff4a108882c7b9a712ac9e 345 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.ping)<>1' 346 | name: 'PBS: API service not available' 347 | priority: HIGH 348 | description: 'The API service is not available. Check your network and authorization settings.' 349 | - 350 | uuid: 6828c238e79e44ea8e9abc5e2d1df636 351 | name: 'PBS: Datastores usage' 352 | type: HTTP_AGENT 353 | key: pbs.status.datastore-usage 354 | history: '0' 355 | trends: '0' 356 | value_type: TEXT 357 | preprocessing: 358 | - 359 | type: JSONPATH 360 | parameters: 361 | - $.data 362 | timeout: 10s 363 | url: 'https://{HOST.CONN}:{$PBS.URL.PORT}/api2/json/status/datastore-usage' 364 | headers: 365 | - 366 | name: Authorization 367 | value: 'PBSAPIToken={$PBS.TOKEN.ID}:{$PBS.TOKEN.SECRET}' 368 | - 369 | uuid: ccce5f04d3fd4ae19b448fcc83726621 370 | name: 'PBS: Failed tasks' 371 | type: HTTP_AGENT 372 | key: pbs.tasks.failed 373 | history: '0' 374 | trends: '0' 375 | value_type: TEXT 376 | timeout: 10s 377 | url: 'https://{HOST.CONN}:{$PBS.URL.PORT}/api2/json/nodes/{$PBS.NODE.NAME}/tasks' 378 | query_fields: 379 | - 380 | name: errors 381 | value: 'true' 382 | - 383 | name: limit 384 | value: '0' 385 | headers: 386 | - 387 | name: Authorization 388 | value: 'PBSAPIToken={$PBS.TOKEN.ID}:{$PBS.TOKEN.SECRET}' 389 | - 390 | uuid: afa0d72849af417883c66c8e19dbd3bc 391 | name: 'PBS: Failed backup tasks count' 392 | type: DEPENDENT 393 | key: pbs.tasks.failed.count_backup 394 | delay: '0' 395 | preprocessing: 396 | - 397 | type: JSONPATH 398 | parameters: 399 | - '$.data[?(@.worker_type == "backup")].length()' 400 | master_item: 401 | key: pbs.tasks.failed 402 | - 403 | uuid: 8a5de2ea308843f6b99b14751abb7948 404 | name: 'PBS: Last failed backup task' 405 | type: DEPENDENT 406 | key: pbs.tasks.failed.last_backup 407 | delay: '0' 408 | trends: '0' 409 | value_type: TEXT 410 | preprocessing: 411 | - 412 | type: JSONPATH 413 | parameters: 414 | - '$.data[?(@.worker_type == "backup")].first()' 415 | - 416 | type: DISCARD_UNCHANGED_HEARTBEAT 417 | parameters: 418 | - '300' 419 | master_item: 420 | key: pbs.tasks.failed 421 | - 422 | uuid: 6e87de4cc7864260aa31471907619c67 423 | name: 'PBS: Last failed backup task time' 424 | type: DEPENDENT 425 | key: pbs.tasks.failed.last_backup_time 426 | delay: '0' 427 | units: unixtime 428 | preprocessing: 429 | - 430 | type: JSONPATH 431 | parameters: 432 | - '$.data[?(@.worker_type == "backup")].first()' 433 | - 434 | type: JSONPATH 435 | parameters: 436 | - $.endtime 437 | - 438 | type: DISCARD_UNCHANGED_HEARTBEAT 439 | parameters: 440 | - '300' 441 | master_item: 442 | key: pbs.tasks.failed 443 | - 444 | uuid: aff3e30fbe5a49c683f48af8851e9ee8 445 | name: 'PBS: Version' 446 | type: HTTP_AGENT 447 | key: pbs.version 448 | trends: '0' 449 | value_type: TEXT 450 | preprocessing: 451 | - 452 | type: JSONPATH 453 | parameters: 454 | - $.data.version 455 | timeout: 30s 456 | url: 'https://{HOST.CONN}:{$PBS.URL.PORT}/api2/json/version' 457 | headers: 458 | - 459 | name: Authorization 460 | value: 'PBSAPIToken={$PBS.TOKEN.ID}:{$PBS.TOKEN.SECRET}' 461 | discovery_rules: 462 | - 463 | uuid: be090237e5d84df9b12ce47b637f726b 464 | name: 'PBS Datastore discovery' 465 | type: DEPENDENT 466 | key: pbs.datastore 467 | delay: '0' 468 | item_prototypes: 469 | - 470 | uuid: fb7cafc51f354529aafe8c220b673c8e 471 | name: 'PBS Datastore: {#DATASTORE} avail' 472 | type: DEPENDENT 473 | key: 'pbs.datastore.avail[{#DATASTORE}]' 474 | delay: '0' 475 | units: B 476 | preprocessing: 477 | - 478 | type: JSONPATH 479 | parameters: 480 | - $.avail 481 | master_item: 482 | key: 'pbs.datastore[{#DATASTORE}]' 483 | - 484 | uuid: 96c7dbf221484b7d8def5d59190dea0a 485 | name: 'PBS Datastore: {#DATASTORE} used percent' 486 | type: CALCULATED 487 | key: 'pbs.datastore.pused[{#DATASTORE}]' 488 | value_type: FLOAT 489 | units: '%' 490 | params: 'last(//pbs.datastore.used[{#DATASTORE}]) / last(//pbs.datastore.total[{#DATASTORE}]) * 100' 491 | trigger_prototypes: 492 | - 493 | uuid: 590f923b656242b5a1bdec6aaef93d62 494 | expression: 'last(/Proxmox Backup Server by HTTP/pbs.datastore.pused[{#DATASTORE}])>{$PBS.STORAGE.PUSE.MAX.WARN}' 495 | name: 'PBS Datastore: {#DATASTORE} high usage' 496 | event_name: 'PBS Datastore: {#DATASTORE} high usage (over {$PBS.STORAGE.PUSE.MAX.WARN} use)' 497 | priority: AVERAGE 498 | description: 'Datastore {#DATASTORE} usage' 499 | - 500 | uuid: 9bec6f569c0d42059c0940538261d6ee 501 | name: 'PBS Datastore: {#DATASTORE} total' 502 | type: DEPENDENT 503 | key: 'pbs.datastore.total[{#DATASTORE}]' 504 | delay: '0' 505 | units: B 506 | preprocessing: 507 | - 508 | type: JSONPATH 509 | parameters: 510 | - $.total 511 | master_item: 512 | key: 'pbs.datastore[{#DATASTORE}]' 513 | - 514 | uuid: 33c0852a8f93444eae457050945ea4ea 515 | name: 'PBS Datastore: {#DATASTORE} used' 516 | type: DEPENDENT 517 | key: 'pbs.datastore.used[{#DATASTORE}]' 518 | delay: '0' 519 | units: B 520 | preprocessing: 521 | - 522 | type: JSONPATH 523 | parameters: 524 | - $.used 525 | master_item: 526 | key: 'pbs.datastore[{#DATASTORE}]' 527 | - 528 | uuid: f5e5f969d67f49769e58734297500e24 529 | name: 'PBS Datastore: {#DATASTORE}' 530 | type: DEPENDENT 531 | key: 'pbs.datastore[{#DATASTORE}]' 532 | delay: '0' 533 | history: '0' 534 | trends: '0' 535 | value_type: TEXT 536 | preprocessing: 537 | - 538 | type: JSONPATH 539 | parameters: 540 | - '$[?(@.store == ''{#DATASTORE}'')]' 541 | - 542 | type: JSONPATH 543 | parameters: 544 | - '$.[0]' 545 | master_item: 546 | key: pbs.status.datastore-usage 547 | master_item: 548 | key: pbs.status.datastore-usage 549 | lld_macro_paths: 550 | - 551 | lld_macro: '{#DATASTORE}' 552 | path: $.store 553 | macros: 554 | - 555 | macro: '{$PBS.CPU.PUSE.MAX.WARN}' 556 | value: '90' 557 | description: 'Maximum used CPU in percentage.' 558 | - 559 | macro: '{$PBS.MEMORY.PUSE.MAX.WARN}' 560 | value: '90' 561 | description: 'Maximum used memory in percentage.' 562 | - 563 | macro: '{$PBS.NODE.NAME}' 564 | value: localhost 565 | description: 'Internal node name of PBS for API. Not used as https host.' 566 | - 567 | macro: '{$PBS.ROOT.PUSE.MAX.WARN}' 568 | value: '90' 569 | description: 'Maximum used root space in percentage.' 570 | - 571 | macro: '{$PBS.STORAGE.PUSE.MAX.WARN}' 572 | value: '90' 573 | description: 'Maximum used storage space in percentage.' 574 | - 575 | macro: '{$PBS.SWAP.PUSE.MAX.WARN}' 576 | value: '90' 577 | description: 'Maximum used swap in percentage.' 578 | - 579 | macro: '{$PBS.TOKEN.ID}' 580 | value: USER@REALM!TOKENID 581 | description: 'API tokens allow stateless access to most parts of the REST API by another system, software or API client.' 582 | - 583 | macro: '{$PBS.TOKEN.SECRET}' 584 | value: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 585 | description: 'Secret key.' 586 | - 587 | macro: '{$PBS.URL.PORT}' 588 | value: '8007' 589 | description: 'The API uses the HTTPS protocol and the server listens to port 8007 by default.' 590 | triggers: 591 | - 592 | uuid: 35eaaae4afdd438d97b9cd01c3a81a24 593 | expression: 'change(/Proxmox Backup Server by HTTP/pbs.tasks.failed.last_backup)<>0 and (now() - last(/Proxmox Backup Server by HTTP/pbs.tasks.failed.last_backup_time) < 86400)' 594 | recovery_mode: RECOVERY_EXPRESSION 595 | recovery_expression: 'change(/Proxmox Backup Server by HTTP/pbs.tasks.failed.last_backup)=0 and (now() - last(/Proxmox Backup Server by HTTP/pbs.tasks.failed.last_backup_time) > 86400)' 596 | name: 'PBS: New failed backup task' 597 | priority: AVERAGE 598 | manual_close: 'YES' 599 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------