| 1 | { |
| 2 | "jsonSchema": { |
| 3 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 4 | "title": "Palo Alto Networks PAN-OS collector configuration.", |
| 5 | "type": "object", |
| 6 | "properties": { |
| 7 | "update_every": { |
| 8 | "title": "Update every", |
| 9 | "description": "Data collection interval, measured in seconds.", |
| 10 | "type": "integer", |
| 11 | "minimum": 1, |
| 12 | "default": 60 |
| 13 | }, |
| 14 | "autodetection_retry": { |
| 15 | "title": "Detection retry", |
| 16 | "description": "Recheck interval in seconds. Zero means no recheck will be scheduled.", |
| 17 | "type": "integer", |
| 18 | "minimum": 0, |
| 19 | "default": 0 |
| 20 | }, |
| 21 | "url": { |
| 22 | "title": "URL", |
| 23 | "description": "The base URL of the PAN-OS firewall management interface.", |
| 24 | "type": "string", |
| 25 | "default": "https://127.0.0.1", |
| 26 | "format": "uri" |
| 27 | }, |
| 28 | "timeout": { |
| 29 | "title": "Timeout", |
| 30 | "description": "PAN-OS XML API request timeout, measured in seconds.", |
| 31 | "type": "number", |
| 32 | "minimum": 1, |
| 33 | "default": 3 |
| 34 | }, |
| 35 | "api_key": { |
| 36 | "title": "API key", |
| 37 | "description": "PAN-OS XML API key. Takes priority over username/password key generation.", |
| 38 | "type": "string", |
| 39 | "sensitive": true |
| 40 | }, |
| 41 | "username": { |
| 42 | "title": "Username", |
| 43 | "description": "PAN-OS administrator username used to generate an API key.", |
| 44 | "type": "string", |
| 45 | "sensitive": true |
| 46 | }, |
| 47 | "password": { |
| 48 | "title": "Password", |
| 49 | "description": "PAN-OS administrator password used to generate an API key.", |
| 50 | "type": "string", |
| 51 | "sensitive": true |
| 52 | }, |
| 53 | "vsys": { |
| 54 | "title": "VSYS", |
| 55 | "description": "Optional PAN-OS virtual system scope for operational commands.", |
| 56 | "type": "string" |
| 57 | }, |
| 58 | "vnode": { |
| 59 | "title": "Vnode", |
| 60 | "description": "Associates this data collection job with a Virtual Node.", |
| 61 | "type": "string" |
| 62 | }, |
| 63 | "tls_skip_verify": { |
| 64 | "title": "Skip TLS verification", |
| 65 | "description": "If set, TLS certificate verification will be skipped.", |
| 66 | "type": "boolean", |
| 67 | "default": false |
| 68 | }, |
| 69 | "tls_ca": { |
| 70 | "title": "TLS CA", |
| 71 | "description": "The path to the CA certificate file for TLS verification.", |
| 72 | "type": "string", |
| 73 | "pattern": "^$|^/" |
| 74 | }, |
| 75 | "tls_cert": { |
| 76 | "title": "TLS certificate", |
| 77 | "description": "The path to the client certificate file for TLS authentication.", |
| 78 | "type": "string", |
| 79 | "pattern": "^$|^/" |
| 80 | }, |
| 81 | "tls_key": { |
| 82 | "title": "TLS key", |
| 83 | "description": "The path to the client key file for TLS authentication.", |
| 84 | "type": "string", |
| 85 | "pattern": "^$|^/" |
| 86 | }, |
| 87 | "proxy_url": { |
| 88 | "title": "Proxy URL", |
| 89 | "description": "The URL of the proxy server.", |
| 90 | "type": "string" |
| 91 | }, |
| 92 | "headers": { |
| 93 | "title": "Headers", |
| 94 | "description": "Additional HTTP headers to include in PAN-OS XML API requests.", |
| 95 | "type": [ |
| 96 | "object", |
| 97 | "null" |
| 98 | ], |
| 99 | "additionalProperties": { |
| 100 | "type": "string" |
| 101 | } |
| 102 | } |
| 103 | }, |
| 104 | "required": [ |
| 105 | "url" |
| 106 | ], |
| 107 | "dependencies": { |
| 108 | "tls_cert": [ |
| 109 | "tls_key" |
| 110 | ], |
| 111 | "tls_key": [ |
| 112 | "tls_cert" |
| 113 | ] |
| 114 | } |
| 115 | }, |
| 116 | "uiSchema": { |
| 117 | "uiOptions": { |
| 118 | "fullPage": true |
| 119 | }, |
| 120 | "ui:flavour": "tabs", |
| 121 | "ui:options": { |
| 122 | "tabs": [ |
| 123 | { |
| 124 | "title": "Base", |
| 125 | "fields": [ |
| 126 | "update_every", |
| 127 | "autodetection_retry", |
| 128 | "url", |
| 129 | "timeout", |
| 130 | "vsys", |
| 131 | "vnode" |
| 132 | ] |
| 133 | }, |
| 134 | { |
| 135 | "title": "Auth", |
| 136 | "fields": [ |
| 137 | "api_key", |
| 138 | "username", |
| 139 | "password" |
| 140 | ] |
| 141 | }, |
| 142 | { |
| 143 | "title": "TLS", |
| 144 | "fields": [ |
| 145 | "tls_skip_verify", |
| 146 | "tls_ca", |
| 147 | "tls_cert", |
| 148 | "tls_key" |
| 149 | ] |
| 150 | }, |
| 151 | { |
| 152 | "title": "Proxy", |
| 153 | "fields": [ |
| 154 | "proxy_url" |
| 155 | ] |
| 156 | }, |
| 157 | { |
| 158 | "title": "Headers", |
| 159 | "fields": [ |
| 160 | "headers" |
| 161 | ] |
| 162 | } |
| 163 | ] |
| 164 | }, |
| 165 | "api_key": { |
| 166 | "ui:widget": "password" |
| 167 | }, |
| 168 | "username": { |
| 169 | "ui:widget": "password" |
| 170 | }, |
| 171 | "password": { |
| 172 | "ui:widget": "password" |
| 173 | }, |
| 174 | "vnode": { |
| 175 | "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here." |
| 176 | } |
| 177 | } |
| 178 | } |