Dell Powerconnect W-ClearPass Virtual Appliances W-ClearPass Guest 6.0 Deploym - Page 269

nwa_quotejs, nwa_radius_query, debug, quiet, method, assign, output, default

Page 269 highlights

The "struct" parameter, if specified, uses a standard result type. If the "error" key is set and non-zero, the "type" parameter is set to the value error, and the "message" key is converted to a HTML formatted error message for display. nwa_quotejs {nwa_quotejs} ... {/nwa_quotejs} Smarty registered block function. Quotes its content in a string format suitable for use in JavaScript. This function also translates UTF-8 sequences into the corresponding JavaScript Unicode escape sequence (\uXXXX) Usage example: {nwa_quotejs}String with ' and "{/nwaquote_js} The output of this will be: 'String with \' and \"' The "body" parameter, if set, indicates that the string quotes are already supplied; in this case the beginning and ending quotes are not included in the output. nwa_radius_query {nwa_radius_query _method=MethodName _assign=var ...} Smarty registered template function. Performs accounting-based queries on the RADIUS server and returns the result for use in a template. Usage example: {nwa_radius_query _method=GetCallingStationTraffic callingstationid=$dhcp_lease.mac_address from_time=86400 in_out=out _assign=total_traffic} This example uses the GetCallingStationTraffic query function and passes the "callingstationid", "from_time" and "in_out" parameters. The result is assigned to a template variable called total_traffic, and will not generate any output. This template function accepts the following parameters to select a RADIUS database and other connection options: l _db - ID of the RADIUS database service handler (this parameter is optional, the default service handler will be used if it not set) l _debug - Set to a nonzero value to enable debugging l _quiet - Set to a nonzero value to inhibit warning/error messages The following parameters control the query to be executed: l _method (required) - Name of the query function to execute. A brief listing of the available methods is provided below. l _arg0, _arg1, ..., _argN (optional) - Positional arguments for the query function. l Named arguments may also be supplied; the arguments must be named identically to the function arguments listed in the documentation for the query function. The following parameters control how the result should be processed: l _assign - Name of a page variable to store the output; if not set, output is sent to the browser as the result of evaluating the template function. l _output - Index of item to return from the RPC result; if not set, the complete result is returned. This may be of use when an array containing multiple values is returned and only one of these values is required. l _default - Default value to display or return if an error occurs or the _output field is not available in the result. For ease of use, "assign" is also supported as a synonym for "_assign". Dell Networking W-ClearPass Guest 6.0 | Deployment Guide nwa_quotejs | 269

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320

The “struct” parameter, if specified, uses a standard result type. If the “error” key is set and non-zero, the “type”
parameter is set to the value error, and the “message” key is converted to a HTML formatted error message for
display.
nwa_quotejs
{nwa_quotejs} … {/nwa_quotejs}
Smarty registered block function. Quotes its content in a string format suitable for use in JavaScript. This function
also translates UTF-8 sequences into the corresponding JavaScript Unicode escape sequence (\uXXXX)
Usage example:
{nwa_quotejs}String with ' and "{/nwaquote_js}
The output of this will be:
'String with \' and \"'
The “body” parameter, if set, indicates that the string quotes are already supplied; in this case the beginning and
ending quotes are not included in the output.
nwa_radius_query
{nwa_radius_query _method=
MethodName
_assign=
var
…}
Smarty registered template function. Performs accounting-based queries on the RADIUS server and returns the result
for use in a template.
Usage example:
{nwa_radius_query _method=GetCallingStationTraffic
callingstationid=$dhcp_lease.mac_address
from_time=86400 in_out=out _assign=total_traffic}
This example uses the
GetCallingStationTraffic
query function and passes the “callingstationid”, “from_time”
and “in_out” parameters. The result is assigned to a template variable called total_traffic, and will not generate any
output.
This template function accepts the following parameters to select a RADIUS database and other connection
options:
l
_db
– ID of the RADIUS database service handler (this parameter is optional, the default service handler will be
used if it not set)
l
_debug
– Set to a nonzero value to enable debugging
l
_quiet
– Set to a nonzero value to inhibit warning/error messages
The following parameters control the query to be executed:
l
_method
(required) – Name of the query function to execute. A brief listing of the available methods is provided
below.
l
_arg0, _arg1, …, _argN
(optional) – Positional arguments for the query function.
l
Named arguments may also be supplied; the arguments must be named identically to the function arguments
listed in the documentation for the query function.
The following parameters control how the result should be processed:
l
_assign
– Name of a page variable to store the output; if not set, output is sent to the browser as the result of
evaluating the template function.
l
_output
– Index of item to return from the RPC result; if not set, the complete result is returned. This may be of
use when an array containing multiple values is returned and only one of these values is required.
l
_default
– Default value to display or return if an error occurs or the _output field is not available in the result.
For ease of use, “assign” is also supported as a synonym for “_assign”.
Dell Networking W-ClearPass Guest 6.0 | Deployment Guide
nwa_quotejs |
269