1/** 2\page dbus wpa_supplicant D-Bus API 3 4This section documents the wpa_supplicant D-Bus API. Every D-Bus 5interface implemented by wpa_supplicant is described here including 6their methods, signals, and properties with arguments, returned 7values, and possible errors. 8 9Interfaces: 10- \ref dbus_main 11- \ref dbus_interface 12- \ref dbus_wps 13- \ref dbus_p2pdevice 14- \ref dbus_bss 15- \ref dbus_network 16- \ref dbus_peer 17- \ref dbus_group 18- \ref dbus_persistent_group 19- \ref dbus_mesh 20 21 22\section dbus_main fi.w1.wpa_supplicant1 23 24Interface implemented by the main wpa_supplicant D-Bus object 25registered in the bus with fi.w1.wpa_supplicant1 name. 26 27\subsection dbus_main_methods Methods 28 29<ul> 30 <li> 31 <h3>CreateInterface ( a{sv} : args ) --> o : interface</h3> 32 <p>Registers a wireless interface in wpa_supplicant.</p> 33 <h4>Arguments</h4> 34 <dl> 35 <dt>a{sv} : args</dt> 36 <dd> 37 A dictionary with arguments used to add the interface to wpa_supplicant. The dictionary may contain the following entries: 38 <table> 39 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> 40 <tr><td>Ifname</td><td>s</td><td>Name of the network interface to control, e.g., wlan0</td><td>Yes</td> 41 <tr><td>BridgeIfname</td><td>s</td><td>Name of the bridge interface to control, e.g., br0</td><td>No</td> 42 <tr><td>Driver</td><td>s</td><td>Driver name which the interface uses, e.g., nl80211</td><td>No</td> 43 <tr><td>ConfigFile</td><td>s</td><td>Configuration file path</td><td>No</td> 44 </table> 45 </dd> 46 </dl> 47 <h4>Returns</h4> 48 <dl> 49 <dt>o : interface</dt> 50 <dd>A D-Bus path to object representing created interface</dd> 51 </dl> 52 <h4>Possible errors</h4> 53 <dl> 54 <dt>fi.w1.wpa_supplicant1.InterfaceExists</dt> 55 <dd>wpa_supplicant already controls this interface.</dd> 56 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 57 <dd>Creating interface failed for an unknown reason.</dd> 58 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 59 <dd>Invalid entries were found in the passed argument.</dd> 60 </dl> 61 </li> 62 63 <li> 64 <h3>RemoveInterface ( o : interface ) --> nothing</h3> 65 <p>Deregisters a wireless interface from wpa_supplicant.</p> 66 <h4>Arguments</h4> 67 <dl> 68 <dt>o : interface</dt> 69 <dd>A D-Bus path to an object representing an interface to remove returned by CreateInterface</dd> 70 </dl> 71 <h4>Possible errors</h4> 72 <dl> 73 <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt> 74 <dd>Object pointed by the path doesn't exist or doesn't represent an interface.</dd> 75 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 76 <dd>Removing interface failed for an unknown reason.</dd> 77 </dl> 78 </li> 79 80 <li> 81 <h3>GetInterface ( s : ifname ) --> o : interface</h3> 82 <p>Returns a D-Bus path to an object related to an interface which wpa_supplicant already controls.</p> 83 <h4>Arguments</h4> 84 <dl> 85 <dt>s : ifname</dt> 86 <dd>Name of the network interface, e.g., wlan0</dd> 87 </dl> 88 <h4>Returns</h4> 89 <dl> 90 <dt>o : interface</dt> 91 <dd>A D-Bus path to an object representing an interface</dd> 92 </dl> 93 <h4>Possible errors</h4> 94 <dl> 95 <dt>fi.w1.wpa_supplicant1.InterfaceUnknown</dt> 96 <dd>An interface with the passed name in not controlled by wpa_supplicant.</dd> 97 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 98 <dd>Getting an interface object path failed for an unknown reason.</dd> 99 </dl> 100 </li> 101 102 <li> 103 <h3>ExpectDisconnect ( ) --> nothing</h3> 104 <p>Notify wpa_supplicant of an externally triggered disconnection, e.g., due to system suspend.</p> 105 </li> 106 </ul> 107 108\subsection dbus_main_properties Properties 109 110<ul> 111 <li> 112 <h3>DebugLevel - s - (read/write)</h3> 113 <p>Global wpa_supplicant debugging level. Possible values are 114 "msgdump" (verbose debugging), "debug" (debugging), 115 "info" (informative), "warning" (warnings), and "error" (errors).</p> 116 </li> 117 118 <li> 119 <h3>DebugTimestamp - b - (read/write)</h3> 120 <p>Global wpa_supplicant debugging parameter. Determines if timestamps are shown in debug logs.</p> 121 </li> 122 123 <li> 124 <h3>DebugShowKeys - b - (read/write)</h3> 125 <p>Global wpa_supplicant debugging parameter. Determines if secrets are shown in debug logs.</p> 126 </li> 127 128 <li> 129 <h3>Interfaces - ao - (read)</h3> 130 <p>An array with paths to D-Bus objects representing controlled interfaces each.</p> 131 </li> 132 133 <li> 134 <h3>EapMethods - as - (read)</h3> 135 <p>An array with supported EAP methods names.</p> 136 </li> 137 138 <li> 139 <h3>Capabilities - as - (read)</h3> 140 <p>An array with supported capabilities (e.g., "ap", "ibss-rsn", "p2p", "interworking").</p> 141 </li> 142 143 <li> 144 <h3>WFDIEs - ay - (read/write)</h3> 145 <p>Wi-Fi Display subelements.</p> 146 </li> 147 </ul> 148 149\subsection dbus_main_signals Signals 150 151<ul> 152 <li> 153 <h3>InterfaceAdded ( o : interface, a{sv} : properties )</h3> 154 <p>A new interface was added to wpa_supplicant.</p> 155 <h4>Arguments</h4> 156 <dl> 157 <dt>o : interface</dt> 158 <dd>A D-Bus path to an object representing the added interface</dd> 159 </dl> 160 <dl> 161 <dt>a{sv} : properties</dt> 162 <dd>A dictionary containing properties of added interface.</dd> 163 </dl> 164 </li> 165 166 <li> 167 <h3>InterfaceRemoved ( o : interface )</h3> 168 <p>An interface was removed from wpa_supplicant.</p> 169 <h4>Arguments</h4> 170 <dl> 171 <dt>o : interface</dt> 172 <dd>A D-Bus path to an object representing the removed interface</dd> 173 </dl> 174 </li> 175 176 <li> 177 <h3>PropertiesChanged ( a{sv} : properties )</h3> 178 <p>Some properties have changed.</p> 179 <h4>Arguments</h4> 180 <dl> 181 <dt>a{sv} : properties</dt> 182 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "DebugParams"</dd> 183 </dl> 184 </li> 185 </ul> 186 187 188\section dbus_interface fi.w1.wpa_supplicant1.Interface 189 190Interface implemented by objects related to network interface added to 191wpa_supplicant, i.e., returned by 192fi.w1.wpa_supplicant1.CreateInterface. 193 194\subsection dbus_interface_methods Methods 195 196<ul> 197 <li> 198 <h3>Scan ( a{sv} : args ) --> nothing</h3> 199 <p>Triggers a scan.</p> 200 <h4>Arguments</h4> 201 <dl> 202 <dt>a{sv} : args</dt> 203 <dd> 204 A dictionary with arguments describing scan type: 205 <table> 206 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> 207 <tr><td>Type</td><td>s</td><td>Type of the scan. Possible values: "active", "passive"</td><td>Yes</td> 208 <tr><td>SSIDs</td><td>aay</td><td>Array of SSIDs to scan for (applies only if scan type is active)</td><td>No</td> 209 <tr><td>IEs</td><td>aay</td><td>Information elements to used in active scan (applies only if scan type is active)</td><td>No</td> 210 <tr><td>Channels</td><td>a(uu)</td><td>Array of frequencies to scan in form of (center, width) in MHz.</td><td>No</td> 211 <tr><td>AllowRoam</td><td>b</td><td>TRUE (or absent) to allow a roaming decision based on the results of this scan, FALSE to prevent a roaming decision.</td><td>No</td> 212 </table> 213 </dd> 214 </dl> 215 <h4>Possible errors</h4> 216 <dl> 217 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 218 <dd>Invalid entries were found in the passed argument.</dd> 219 </dl> 220 </li> 221 222 <li> 223 <h3>Disconnect ( ) --> nothing</h3> 224 <p>Disassociates the interface from current network.</p> 225 <h4>Possible errors</h4> 226 <dl> 227 <dt>fi.w1.wpa_supplicant1.NotConnected</dt> 228 <dd>Interface is not connected to any network.</dd> 229 </dl> 230 </li> 231 232 <li> 233 <h3>AddNetwork ( a{sv} : args ) --> o : network</h3> 234 <p>Adds a new network to the interface.</p> 235 <h4>Arguments</h4> 236 <dl> 237 <dt>a{sv} : args</dt> 238 <dd>A dictionary with network configuration. Dictionary entries are equivalent to entries in the "network" block in wpa_supplicant configuration file. Entry values should be appropriate type to the entry, e.g., an entry with key "frequency" should have value type int.</dd> 239 </dl> 240 <h4>Returns</h4> 241 <dl> 242 <dt>o : network</dt> 243 <dd>A D-Bus path to an object representing a configured network</dd> 244 </dl> 245 <h4>Possible errors</h4> 246 <dl> 247 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 248 <dd>Invalid entries were found in the passed argument.</dd> 249 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 250 <dd>Adding network failed for an unknown reason.</dd> 251 </dl> 252 </li> 253 254 <li> 255 <h3>RemoveNetwork ( o : network ) --> nothing</h3> 256 <p>Removes a configured network from the interface.</p> 257 <h4>Arguments</h4> 258 <dl> 259 <dt>o : network</dt> 260 <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd> 261 </dl> 262 <h4>Possible errors</h4> 263 <dl> 264 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt> 265 <dd>A passed path doesn't point to any network object.</dd> 266 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 267 <dd>A passed path doesn't point to any network object.</dd> 268 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 269 <dd>Removing network failed for an unknown reason.</dd> 270 </dl> 271 </li> 272 273 <li> 274 <h3>RemoveAllNetworks ( ) --> nothing</h3> 275 <p>Remove all configured networks from the interface.</p> 276 </li> 277 278 <li> 279 <h3>SelectNetwork ( o : network ) --> nothing</h3> 280 <p>Attempt association with a configured network.</p> 281 <h4>Arguments</h4> 282 <dl> 283 <dt>o : network</dt> 284 <dd>A D-Bus path to an object representing a configured network returned by fi.w1.wpa_supplicant1.Interface.AddNetwork</dd> 285 </dl> 286 <h4>Possible errors</h4> 287 <dl> 288 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt> 289 <dd>A passed path doesn't point to any network object.</dd> 290 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 291 <dd>A passed path doesn't point to any network object.</dd> 292 </dl> 293 </li> 294 295 <li> 296 <h3>Reassociate ( ) --> nothing</h3> 297 <p>Attempt reassociation.</p> 298 <h4>Possible errors</h4> 299 <dl> 300 <dt>fi.w1.wpa_supplicant1.InterfaceDisabled</dt> 301 <dd>The interface is disabled.</dd> 302 </dl> 303 </li> 304 305 <li> 306 <h3>Reattach ( ) --> nothing</h3> 307 <p>Attempt reassociation back to the current BSS.</p> 308 <h4>Possible errors</h4> 309 <dl> 310 <dt>fi.w1.wpa_supplicant1.NotConnected</dt> 311 <dd>Interface is not connected to any network.</dd> 312 </dl> 313 </li> 314 315 <li> 316 <h3>Reconnect ( ) --> nothing</h3> 317 <p>Attempt reconnection and connect if in disconnected state.</p> 318 <h4>Possible errors</h4> 319 <dl> 320 <dt>fi.w1.wpa_supplicant1.InterfaceDisabled</dt> 321 <dd>The interface is disabled.</dd> 322 </dl> 323 </li> 324 325 <li> 326 <h3>Roam ( s : addr ) --> nothing</h3> 327 <p>Initiate a roam to another BSS within the current ESS.</p> 328 <h4>Possible errors</h4> 329 <dl> 330 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 331 <dd>Missing address argument.</dd> 332 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 333 <dd>Invalid hardware address format.</dd> 334 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 335 <dd>Target BSS not found.</dd> 336 <dt>fi.w1.wpa_supplicant1.NotConnected</dt> 337 <dd>Interface is not connected to any network.</dd> 338 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 339 <dd>Scan processing was not included in the build.</dd> 340 </dl> 341 </li> 342 343 <li> 344 <h3>AddBlob ( s : name, ay : data ) --> nothing</h3> 345 <p>Adds a blob to the interface.</p> 346 <h4>Arguments</h4> 347 <dl> 348 <dt>s : name</dt> 349 <dd>A name of a blob</dd> 350 <dt>ay : data</dt> 351 <dd>A blob data</dd> 352 </dl> 353 <h4>Possible errors</h4> 354 <dl> 355 <dt>fi.w1.wpa_supplicant1.BlobExists</dt> 356 <dd>A blob with the specified name already exists.</dd> 357 </dl> 358 </li> 359 360 <li> 361 <h3>RemoveBlob ( s : name ) --> nothing</h3> 362 <p>Removes the blob from the interface.</p> 363 <h4>Arguments</h4> 364 <dl> 365 <dt>s : name</dt> 366 <dd>A name of the blob to remove</dd> 367 </dl> 368 <h4>Possible errors</h4> 369 <dl> 370 <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt> 371 <dd>A blob with the specified name doesn't exist.</dd> 372 </dl> 373 </li> 374 375 <li> 376 <h3>GetBlob ( s : name ) --> ay : data</h3> 377 <p>Returns the blob data of a previously added blob.</p> 378 <h4>Arguments</h4> 379 <dl> 380 <dt>s : name</dt> 381 <dd>A name of the blob</dd> 382 </dl> 383 <h4>Returns</h4> 384 <dl> 385 <dt>ay : data</dt> 386 <dd>A blob data</dd> 387 </dl> 388 <h4>Possible errors</h4> 389 <dl> 390 <dt>fi.w1.wpa_supplicant1.BlobUnknown</dt> 391 <dd>A blob with the specified name doesn't exist.</dd> 392 </dl> 393 </li> 394 <li> 395 <h3>AutoScan ( s : arg ) --> nothing</h3> 396 <p>Set autoscan parameters for the interface.</p> 397 <h4>Arguments</h4> 398 <dl> 399 <dt>s : arg</dt> 400 <dd>Autoscan parameter line or empty to unset autoscan.</dd> 401 </dl> 402 <h4>Possible errors</h4> 403 <dl> 404 <dt>fi.w1.wpa_supplicant1.NoMemory</dt> 405 <dd>Needed memory was not possible to get allocated.</dd> 406 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 407 <dd>Invalid entries were found in the passed argument.</dd> 408 </dl> 409 </li> 410 <li> 411 <h3>TDLSDiscover ( s : peer_address ) --> nothing</h3> 412 <p>Initiate a TDLS discovery for a peer.</p> 413 <h4>Arguments</h4> 414 <dl> 415 <dt>s : peer_address</dt> 416 <dd>MAC address for the peer to perform TDLS discovery.</dd> 417 </dl> 418 <h4>Possible errors</h4> 419 <dl> 420 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 421 <dd>The "peer_address" argument is not a properly formatted MAC.</dd> 422 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 423 <dd>Initiating the TDLS operation failed for an unknown reason.</dd> 424 </dl> 425 </li> 426 <li> 427 <h3>TDLSSetup ( s : peer_address ) --> nothing</h3> 428 <p>Setup a TDLS session for a peer.</p> 429 <h4>Arguments</h4> 430 <dl> 431 <dt>s : peer_address</dt> 432 <dd>MAC address for the peer to perform TDLS setup.</dd> 433 </dl> 434 <h4>Possible errors</h4> 435 <dl> 436 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 437 <dd>The "peer_address" argument is not a properly formatted MAC.</dd> 438 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 439 <dd>Initiating the TDLS operation failed for an unknown reason.</dd> 440 </dl> 441 </li> 442 <li> 443 <h3>TDLSStatus ( s : peer_address ) --> s</h3> 444 <p>Return TDLS status with respect to a peer.</p> 445 <h4>Arguments</h4> 446 <dl> 447 <dt>s : peer_address</dt> 448 <dd>MAC address for the peer for which status is requested.</dd> 449 </dl> 450 <h4>Returns</h4> 451 <dl> 452 <dt>s : status</dt> 453 <dd>Current status of the TDLS link with the selected peer.</dd> 454 </dl> 455 <h4>Possible errors</h4> 456 <dl> 457 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 458 <dd>The "peer_address" argument is not a properly formatted MAC.</dd> 459 </dl> 460 </li> 461 <li> 462 <h3>TDLSTeardown ( s : peer_address ) --> nothing</h3> 463 <p>Tear down a TDLS session with a peer.</p> 464 <h4>Arguments</h4> 465 <dl> 466 <dt>s : peer_address</dt> 467 <dd>MAC address for the peer to tear down TDLS connectivity with.</dd> 468 </dl> 469 <h4>Possible errors</h4> 470 <dl> 471 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 472 <dd>The "peer_address" argument is not a properly formatted MAC.</dd> 473 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 474 <dd>Initiating the TDLS operation failed for an unknown reason.</dd> 475 </dl> 476 </li> 477 <li> 478 <h3>TDLSChannelSwitch ( a{sv} : args ) --> nothing</h3> 479 <p>Configure TDLS channel switching behavior with a peer.</p> 480 <h4>Arguments</h4> 481 <dl> 482 <dt>a{sv} : args</dt> 483 <dd>A dictionary with arguments identifying the peer and channel switching behavior.</dd> 484 </dl> 485 </li> 486 <li> 487 <h3>TDLSCancelChannelSwitch ( s : peer_address ) --> nothing</h3> 488 <p>Disable channel switching for a TDLS session with a peer.</p> 489 <h4>Arguments</h4> 490 <dl> 491 <dt>s : peer_address</dt> 492 <dd>MAC address for the peer.</dd> 493 </dl> 494 </li> 495 <li> 496 <h3>VendorElemAdd ( i: frame_id, ay: ielems ) --> nothing</h3> 497 <p>Add Vendor Elements to corresponding frame ID.</p> 498 <h4>Arguments</h4> 499 <dl> 500 <dt>i : frame_id</dt> 501 <dd>Frame ID for which Vendor specific IE is to be added.</dd> 502 <dt>ay : ielems</dt> 503 <dd>Information Element(s).</dd> 504 </dl> 505 <h4>Possible errors</h4> 506 <dl> 507 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 508 <dd>The "ielems" argument is not a properly formatted or size mismatch.</dd> 509 <dt>fi.w1.wpa_supplicant1.NoMemory</dt> 510 <dd>Needed memory was not possible to get allocated.</dd> 511 </dl> 512 </li> 513 <li> 514 <h3>VendorElemGet ( i: frame_id ) --> ay: ielems</h3> 515 <p>Get Vendor Elements of corresponding frame ID.</p> 516 <h4>Arguments</h4> 517 <dl> 518 <dt>i : frame_id</dt> 519 <dd>Frame ID for which Vendor specific IE is being queried.</dd> 520 <dt>ay : ielems</dt> 521 <dd>Information Element(s).</dd> 522 </dl> 523 <h4>Possible errors</h4> 524 <dl> 525 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 526 <dd>The "frame_id" argument is not valid.</dd> 527 </dl> 528 </li> 529 <li> 530 <h3>VendorElemRem ( i: frame_id, ay: ielems ) --> nothing</h3> 531 <p>Remove Vendor Elements of corresponding frame ID.</p> 532 <h4>Arguments</h4> 533 <dl> 534 <dt>i : frame_id</dt> 535 <dd>Frame ID for which Vendor specific IE is to be removed.</dd> 536 <dt>ay : ielems</dt> 537 <dd>Information Element(s) OR * to remove all.</dd> 538 </dl> 539 <h4>Possible errors</h4> 540 <dl> 541 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 542 <dd>The "ielems" argument is not a properly formatted or size mismatch.</dd> 543 <dt>fi.w1.wpa_supplicant1.NoMemory</dt> 544 <dd>Needed memory was not possible to get allocated.</dd> 545 </dl> 546 </li> 547 <li> 548 <h3>SaveConfig ( ) --> nothing</h3> 549 <p>Save configuration to the configuration file.</p> 550 </li> 551 <li> 552 <h3>AbortScan ( ) --> nothing</h3> 553 <p>Abort ongoing scan operation.</p> 554 </li> 555 <li> 556 <h3>AddCred ( a{sv} : args ) --> o : path</h3> 557 <p>Add an Interworking/Hotspot 2.0 credential.</p> 558 <h4>Arguments</h4> 559 <dl> 560 <dt>a{sv} : args</dt> 561 <dd>A dictionary with credential configuration. Dictionary entries are equivalent to entries in the "cred" block in wpa_supplicant configuration file.</dd> 562 </dl> 563 <h4>Returns</h4> 564 <dl> 565 <dt>o : path</dt> 566 <dd>A D-Bus path to an object representing the added credential</dd> 567 </dl> 568 </li> 569 <li> 570 <h3>RemoveCred ( o : path ) --> nothing</h3> 571 <p>Remove the specified Interworking/Hotspot 2.0 credential.</p> 572 </li> 573 <li> 574 <h3>RemoveAllCreds ( ) --> nothing</h3> 575 <p>Remove all configured Interworking/Hotspot 2.0 credentials.</p> 576 </li> 577 <li> 578 <h3>InterworkingSelect ( ) --> nothing</h3> 579 <p>Perform Interworking (Hotspot 2.0) network selection.</p> 580 </li> 581 <li> 582 <h3>EAPLogoff ( ) --> nothing</h3> 583 <p>IEEE 802.1X EAPOL state machine logoff.</p> 584 </li> 585 <li> 586 <h3>EAPLogon ( ) --> nothing</h3> 587 <p>IEEE 802.1X EAPOL state machine logon.</p> 588 </li> 589 590 <li> 591 <h3>NetworkReply ( o : network, s : field, s : value ) --> nothing</h3> 592 <p>Provide parameter requested by NetworkRequest().</p> 593 <h4>Arguments</h4> 594 <dl> 595 <dt>o : network</dt> 596 <dd>A D-Bus path to an object representing the network (copied from NetworkRequest()).</dd> 597 <dt>s : field</dt> 598 <dd>Requested information (copied from NetworkRequest()).</dd> 599 <dt>s : value</dt> 600 <dd>The requested information (e.g., password for EAP authentication).</dd> 601 </dl> 602 <h4>Possible errors</h4> 603 <dl> 604 <dt>fi.w1.wpa_supplicant1.NetworkUnknown</dt> 605 <dd>A passed path doesn't point to any network object.</dd> 606 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 607 <dd>A passed path doesn't point to any network object.</dd> 608 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 609 <dd>IEEE 802.1X support was not included in the build.</dd> 610 </dl> 611 </li> 612 613 <li> 614 <h3>SetPKCS11EngineAndModulePath ( s : pkcs11_engine_path, s : pkcs11_module_path ) --> nothing</h3> 615 <p>Set PKCS #11 engine and module path.</p> 616 <h4>Arguments</h4> 617 <dl> 618 <dt>s : pkcs11_engine_path</dt> 619 <dd>PKCS #11 engine path.</dd> 620 <dt>s : pkcs11_module_path</dt> 621 <dd>PKCS #11 module path.</dd> 622 </dl> 623 <h4>Possible errors</h4> 624 <dl> 625 <dt>org.freedesktop.DBus.Error.Failed.InvalidArgs</dt> 626 <dd>Invalid PKCS #11 engine or module path.</dd> 627 <dt>org.freedesktop.DBus.Error.Failed</dt> 628 <dd>Reinit of the EAPOL state machine with the new PKCS #11 engine and module path failed.</dd> 629 </dl> 630 </li> 631 <li> 632 <h3>SignalPoll ( ) --> a{sv} : properties</h3> 633 <p>Fetch signal properties for the current connection.</p> 634 <h4>Returns</h4> 635 <dl> 636 <dt>a{sv} : properties</dt> 637 <dd> 638 <table> 639 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> 640 <tr><td>linkspeed</td><td>i</td><td>Link speed (Mbps)</td><td>No</td> 641 <tr><td>noise</td><td>i</td><td>Noise (dBm)</td><td>No</td> 642 <tr><td>width</td><td>s</td><td>Channel width</td><td>No</td> 643 <tr><td>frequency</td><td>u</td><td>Frequency (MHz)</td><td>No</td> 644 <tr><td>rssi</td><td>i</td><td>RSSI (dBm)</td><td>No</td> 645 <tr><td>avg-rssi</td><td>i</td><td>Average RSSI (dBm)</td><td>No</td> 646 <tr><td>center-frq1</td><td>i</td><td>VHT segment 1 frequency (MHz)</td><td>No</td> 647 <tr><td>center-frq2</td><td>i</td><td>VHT segment 2 frequency (MHz)</td><td>No</td> 648 </table> 649 </dd> 650 </dl> 651 </li> 652 <li> 653 <h3>FlushBSS ( u : age ) --> nothing</h3> 654 <p>Flush BSS entries from the cache.</p> 655 <h4>Arguments</h4> 656 <dl> 657 <dt>u : age</dt> 658 <dd>Maximum age in seconds for BSS entries to keep in cache (0 = remove all entries).</dd> 659 </dl> 660 </li> 661 662 <li> 663 <h3>SubscribeProbeReq ( ) --> nothing</h3> 664 <p>Subscribe to receive Probe Request events. This is needed in addition to registering a signal handler for the ProbeRequest signal to avoid flooding D-Bus with all Probe Request indications when no application is interested in them.</p> 665 <h4>Possible errors</h4> 666 <dl> 667 <dt>fi.w1.wpa_supplicant1.SubscriptionInUse</dt> 668 <dd>Another application is already subscribed.</dd> 669 <dt>fi.w1.wpa_supplicant1.NoMemory</dt> 670 <dd>Needed memory was not possible to get allocated.</dd> 671 </dl> 672 </li> 673 674 <li> 675 <h3>UnsubscribeProbeReq ( ) --> nothing</h3> 676 <p>Unsubscribe from receiving Probe Request events.</p> 677 <h4>Possible errors</h4> 678 <dl> 679 <dt>fi.w1.wpa_supplicant1.NoSubscription</dt> 680 <dd>No subscription in place.</dd> 681 <dt>fi.w1.wpa_supplicant1.SubscriptionNotYou</dt> 682 <dd>Subscription in place, but for another process.</dd> 683 </dl> 684 </li> 685 </ul> 686 687\subsection dbus_interface_properties Properties 688 689<ul> 690 <li> 691 <h3>Capabilities - a{sv} - (read)</h3> 692 <p>Capabilities of the interface. Dictionary contains following entries:</p> 693 <table> 694 <tr><th>Key</th><th>Value type</th><th>Description</th> 695 <tr><td>Pairwise</td><td>as</td><td>Possible array elements: "ccmp-256", "gcmp-256", "ccmp", "gcmp", "tkip", "none"</td> 696 <tr><td>Group</td><td>as</td><td>Possible array elements: "ccmp-256", "gcmp-256", "ccmp", "gcmp", "tkip", "wep104", "wep40"</td> 697 <tr><td>GroupMgmt</td><td>as</td><td>Possible array elements: "aes-128-cmac", "bip-gmac-128", "bip-gmac-256", "bip-cmac-256"</td> 698 <tr><td>KeyMgmt</td><td>as</td><td>Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "sae", "owe", "ieee8021x", "wpa-none", "wps", "none"</td> 699 <tr><td>Protocol</td><td>as</td><td>Possible array elements: "rsn", "wpa"</td> 700 <tr><td>AuthAlg</td><td>as</td><td>Possible array elements: "open", "shared", "leap"</td> 701 <tr><td>Scan</td><td>as</td><td>Possible array elements: "active", "passive", "ssid"</td> 702 <tr><td>Modes</td><td>as</td><td>Possible array elements: "infrastructure", "ad-hoc", "ap"</td> 703 </table> 704 </li> 705 706 <li> 707 <h3>State - s - (read)</h3> 708 <p>A state of the interface. Possible values are: return "disconnected", "inactive", "scanning", "authenticating", "associating", "associated", "4way_handshake", "group_handshake", "completed","unknown".</p> 709 </li> 710 711 <li> 712 <h3>Scanning - b - (read)</h3> 713 <p>Determines if the interface is already scanning or not</p> 714 </li> 715 716 <li> 717 <h3>ApScan - u - (read/write)</h3> 718 <p>Identical to ap_scan entry in wpa_supplicant configuration file. Possible values are 0, 1 or 2.</p> 719 </li> 720 721 <li> 722 <h3>BSSExpireAge - u - (read/write)</h3> 723 <p>Identical to bss_expiration_age entry in wpa_supplicant configuration file.</p> 724 </li> 725 726 <li> 727 <h3>BSSExpireCount - u - (read/write)</h3> 728 <p>Identical to bss_expiration_scan_count entry in wpa_supplicant configuration file.</p> 729 </li> 730 731 <li> 732 <h3>Country - s - (read/write)</h3> 733 <p>Identical to country entry in wpa_supplicant configuration file.</p> 734 </li> 735 736 <li> 737 <h3>Ifname - s - (read)</h3> 738 <p>Name of network interface controlled by the interface, e.g., wlan0.</p> 739 </li> 740 741 <li> 742 <h3>BridgeIfname - s - (read)</h3> 743 <p>Name of bridge network interface controlled by the interface, e.g., br0.</p> 744 </li> 745 746 <li> 747 <h3>Driver - s - (read)</h3> 748 <p>Name of driver used by the interface, e.g., nl80211.</p> 749 </li> 750 751 <li> 752 <h3>ConfigFile - s - (read)</h3> 753 <p>Configuration file path. Returns an empty string if no configuration file is in use.</p> 754 </li> 755 756 <li> 757 <h3>CurrentBSS - o - (read)</h3> 758 <p>Path to D-Bus object representing BSS which wpa_supplicant is associated with, or "/" if is not associated at all.</p> 759 </li> 760 761 <li> 762 <h3>CurrentNetwork - o - (read)</h3> 763 <p>Path to D-Bus object representing configured network which wpa_supplicant uses at the moment, or "/" if doesn't use any.</p> 764 </li> 765 766 <li> 767 <h3>CurrentAuthMode - s - (read)</h3> 768 <p>Current authentication type.</p> 769 </li> 770 771 <li> 772 <h3>Blobs - as - (read)</h3> 773 <p>List of blobs names added to the Interface.</p> 774 </li> 775 776 <li> 777 <h3>BSSs - ao - (read)</h3> 778 <p>List of D-Bus objects paths representing BSSs known to the interface, i.e., scan results.</p> 779 </li> 780 781 <li> 782 <h3>Stations - ao - (read)</h3> 783 <p>List of D-Bus objects paths representing connected stations in AP mode.</p> 784 </li> 785 786 <li> 787 <h3>Networks - ao - (read)</h3> 788 <p>List of D-Bus objects paths representing configured networks.</p> 789 </li> 790 791 <li> 792 <h3>FastReauth - b - (read/write)</h3> 793 <p>Identical to fast_reauth entry in wpa_supplicant configuration file.</p> 794 </li> 795 796 <li> 797 <h3>ScanInterval - i - (read/write)</h3> 798 <p>Time (in seconds) between scans for a suitable AP. Must be >= 0.</p> 799 </li> 800 801 <li> 802 <h3>PKCS11EnginePath - s - (read)</h3> 803 <p>PKCS #11 engine path.</p> 804 </li> 805 806 <li> 807 <h3>PKCS11ModulePath - s - (read)</h3> 808 <p>PKCS #11 module path.</p> 809 </li> 810 811 <li> 812 <h3>DisconnectReason - i - (read)</h3> 813 <p>The most recent IEEE 802.11 reason code for disconnect. Negative value indicates locally generated disconnection.</p> 814 </li> 815 816 <li> 817 <h3>AuthStatusCode - i - (read)</h3> 818 <p>The most recent IEEE 802.11 status code for authentication.</p> 819 </li> 820 821 <li> 822 <h3>AssocStatusCode - i - (read)</h3> 823 <p>The most recent IEEE 802.11 status code for association rejection.</p> 824 </li> 825 826 <li> 827 <h3>RoamTime - u - (read)</h3> 828 <p>The most recent roam time in milliseconds.</p> 829 </li> 830 831 <li> 832 <h3>RoamComplete - b - (read)</h3> 833 <p>The most recent roam success or failure.</p> 834 </li> 835 836 <li> 837 <h3>SessionLength - u - (read)</h3> 838 <p>The most recent BSS session length in milliseconds.</p> 839 </li> 840 841 <li> 842 <h3>BSSTMStatus - u - (read)</h3> 843 <p>The most recent BSS Transition Management status code.</p> 844 </li> 845 846 <li> 847 <h3>EapolVersion - s - (read/write)</h3> 848 <p>IEEE 802.1X/EAPOL version number</p> 849 </li> 850 851 <li> 852 <h3>Bgscan - s - (read/write)</h3> 853 <p>Background scan and roaming parameters or an empty string if none</p> 854 </li> 855 856 <li> 857 <h3>DisableScanOffload - s - (read/write)</h3> 858 <p>Disable automatic offloading of scan requests</p> 859 </li> 860 861 <li> 862 <h3>OpenscEnginePath - s - (read/write)</h3> 863 <p>Path to the OpenSSL engine for opensc</p> 864 </li> 865 866 <li> 867 <h3>OpensslCiphers - s - (read/write)</h3> 868 <p>OpenSSL cipher string</p> 869 </li> 870 871 <li> 872 <h3>PcscReader - s - (read/write)</h3> 873 <p>PC/SC reader name prefix</p> 874 </li> 875 876 <li> 877 <h3>PcscPin - s - (read/write)</h3> 878 <p>PIN for USIM, GSM SIM, and smartcards</p> 879 </li> 880 881 <li> 882 <h3>ExternalSim - s - (read/write)</h3> 883 <p>Use external processing for SIM/USIM operations</p> 884 </li> 885 886 <li> 887 <h3>DriverParam - s - (read/write)</h3> 888 <p>Driver interface parameters</p> 889 </li> 890 891 <li> 892 <h3>Dot11RSNAConfigPMKLifetime - s - (read/write)</h3> 893 <p>Maximum lifetime of a PMK</p> 894 </li> 895 896 <li> 897 <h3>Dot11RSNAConfigPMKReauthThreshold - s - (read/write)</h3> 898 <p>PMK re-authentication threshold</p> 899 </li> 900 901 <li> 902 <h3>Dot11RSNAConfigSATimeout - s - (read/write)</h3> 903 <p>Security association timeout</p> 904 </li> 905 906 <li> 907 <h3>BssMaxCount - s - (read/write)</h3> 908 <p>Maximum number of BSS entries to keep in memory</p> 909 </li> 910 911 <li> 912 <h3>FilterSsids - s - (read/write)</h3> 913 <p>SSID-based scan result filtering</p> 914 </li> 915 916 <li> 917 <h3>FilterRssi - s - (read/write)</h3> 918 <p>RSSI-based scan result filtering</p> 919 </li> 920 921 <li> 922 <h3>MaxNumSta - s - (read/write)</h3> 923 <p>Maximum number of STAs in an AP/P2P GO</p> 924 </li> 925 926 <li> 927 <h3>DisassocLowAck - s - (read/write)</h3> 928 <p>Disassocicate stations with massive packet loss</p> 929 </li> 930 931 <li> 932 <h3>Interworking - s - (read/write)</h3> 933 <p>Whether Interworking (IEEE 802.11u) is enabled</p> 934 </li> 935 936 <li> 937 <h3>Hessid - s - (read/write)</h3> 938 <p>Homogeneous ESS identifier</p> 939 </li> 940 941 <li> 942 <h3>AccessNetworkType - s - (read/write)</h3> 943 <p>Access Network Type</p> 944 </li> 945 946 <li> 947 <h3>PbcInM1 - s - (read/write)</h3> 948 <p>AP mode WPS probing workaround for PBC with Windows 7</p> 949 </li> 950 951 <li> 952 <h3>Autoscan - s - (read/write)</h3> 953 <p>Automatic scan parameters or an empty string if none</p> 954 </li> 955 956 <li> 957 <h3>WpsNfcDevPwId - s - (read/write)</h3> 958 <p>NFC Device Password ID for password token</p> 959 </li> 960 961 <li> 962 <h3>WpsNfcDhPubkey - s - (read/write)</h3> 963 <p>NFC DH Public Key for password token</p> 964 </li> 965 966 <li> 967 <h3>WpsNfcDhPrivkey - s - (read/write)</h3> 968 <p>NFC DH Private Key for password token</p> 969 </li> 970 971 <li> 972 <h3>WpsNfcDevPw - s - (read/write)</h3> 973 <p>NFC Device Password for password token</p> 974 </li> 975 976 <li> 977 <h3>ExtPasswordBackend - s - (read/write)</h3> 978 <p>External password backend or an empty string if none</p> 979 </li> 980 981 <li> 982 <h3>P2pGoMaxInactivity - s - (read/write)</h3> 983 <p>Timeout in seconds to detect STA inactivity</p> 984 </li> 985 986 <li> 987 <h3>AutoInterworking - s - (read/write)</h3> 988 <p>Whether to use network selection automatically</p> 989 </li> 990 991 <li> 992 <h3>Okc - s - (read/write)</h3> 993 <p>Whether to enable opportunistic key caching by default</p> 994 </li> 995 996 <li> 997 <h3>Pmf - s - (read/write)</h3> 998 <p>Whether to enable/require PMF by default</p> 999 </li> 1000 1001 <li> 1002 <h3>SaeGroups - s - (read/write)</h3> 1003 <p>Preference list of enabled groups for SAE</p> 1004 </li> 1005 1006 <li> 1007 <h3>DtimPeriod - s - (read/write)</h3> 1008 <p>Default DTIM period in Beacon intervals</p> 1009 </li> 1010 1011 <li> 1012 <h3>BeaconInt - s - (read/write)</h3> 1013 <p>Default Beacon interval in TU</p> 1014 </li> 1015 1016 <li> 1017 <h3>IgnoreOldScanRes - s - (read/write)</h3> 1018 <p>Ignore scan results older than request</p> 1019 </li> 1020 1021 <li> 1022 <h3>FreqList - s - (read/write)</h3> 1023 <p>Array of allowed scan frequencies or an empty string for all</p> 1024 </li> 1025 1026 <li> 1027 <h3>ScanCurFreq - s - (read/write)</h3> 1028 <p>Whether to scan only the current channel</p> 1029 </li> 1030 1031 <li> 1032 <h3>SchedScanInterval - s - (read/write)</h3> 1033 <p>schedule scan interval</p> 1034 </li> 1035 1036 <li> 1037 <h3>TdlsExternalControl - s - (read/write)</h3> 1038 <p>External control for TDLS setup requests</p> 1039 </li> 1040 1041 <li> 1042 <h3>OsuDir - s - (read/write)</h3> 1043 <p>OSU provider information directory</p> 1044 </li> 1045 1046 <li> 1047 <h3>WowlanTriggers - s - (read/write)</h3> 1048 <p>Wake-on-WLAN triggers</p> 1049 </li> 1050 1051 <li> 1052 <h3>P2pSearchDelay - s - (read/write)</h3> 1053 <p>Extra delay between concurrent search iterations</p> 1054 </li> 1055 1056 <li> 1057 <h3>MacAddr - s - (read/write)</h3> 1058 <p>MAC address policy default</p> 1059 </li> 1060 1061 <li> 1062 <h3>RandAddrLifetime - s - (read/write)</h3> 1063 <p>Lifetime of random MAC address in seconds</p> 1064 </li> 1065 1066 <li> 1067 <h3>PreassocMacAddr - s - (read/write)</h3> 1068 <p>Pre-association MAC address policy</p> 1069 </li> 1070 1071 <li> 1072 <h3>KeyMgmtOffload - s - (read/write)</h3> 1073 <p>Use key management offload</p> 1074 </li> 1075 1076 <li> 1077 <h3>PassiveScan - s - (read/write)</h3> 1078 <p>Whether to force passive scan for network connection</p> 1079 </li> 1080 1081 <li> 1082 <h3>ReassocSameBssOptim - s - (read/write)</h3> 1083 <p>Whether to optimize reassoc-to-same-BSS</p> 1084 </li> 1085 1086 <li> 1087 <h3>WpsPriority - s - (read/write)</h3> 1088 <p>Priority for the networks added through WPS</p> 1089 </li> 1090 1091 <li> 1092 <h3>MACAddressRandomizationMask - a{say} - (read/write)</h3> 1093 <p>Masks to show which bits not to randomize with MAC address randomization. Possible keys are "scan", "sched_scan", and "pno". Values must be an array of 6 bytes.</p> 1094 <p>When this property is set, the new dictionary replaces the old value, rather than merging them together. Leaving a key out of the dictionary will turn off MAC address randomization for that scan type.</p> 1095 </li> 1096 </ul> 1097 1098\subsection dbus_interface_signals Signals 1099 1100<ul> 1101 <li> 1102 <h3>ScanDone ( b : success )</h3> 1103 <p>Scanning finished. </p> 1104 <h4>Arguments</h4> 1105 <dl> 1106 <dt>s : success</dt> 1107 <dd>Determines if scanning was successful. If so, results are available.</dd> 1108 </dl> 1109 </li> 1110 1111 <li> 1112 <h3>BSSAdded ( o : BSS, a{sv} : properties )</h3> 1113 <p>Interface became aware of a new BSS.</p> 1114 <h4>Arguments</h4> 1115 <dl> 1116 <dt>o : BSS</dt> 1117 <dd>A D-Bus path to an object representing the new BSS.</dd> 1118 </dl> 1119 <dl> 1120 <dt>a{sv} : properties</dt> 1121 <dd>A dictionary containing properties of added BSS.</dd> 1122 </dl> 1123 </li> 1124 1125 <li> 1126 <h3>BSSRemoved ( o : BSS )</h3> 1127 <p>BSS disappeared.</p> 1128 <h4>Arguments</h4> 1129 <dl> 1130 <dt>o : BSS</dt> 1131 <dd>A D-Bus path to an object representing the BSS.</dd> 1132 </dl> 1133 </li> 1134 1135 <li> 1136 <h3>BlobAdded ( s : blobName )</h3> 1137 <p>A new blob has been added to the interface.</p> 1138 <h4>Arguments</h4> 1139 <dl> 1140 <dt>s : blobName</dt> 1141 <dd>A name of the added blob.</dd> 1142 </dl> 1143 </li> 1144 1145 <li> 1146 <h3>BlobRemoved ( s : blobName )</h3> 1147 <p>A blob has been removed from the interface.</p> 1148 <h4>Arguments</h4> 1149 <dl> 1150 <dt>s : blobName</dt> 1151 <dd>A name of the removed blob.</dd> 1152 </dl> 1153 </li> 1154 1155 <li> 1156 <h3>NetworkAdded ( o : network, a{sv} : properties )</h3> 1157 <p>A new network has been added to the interface.</p> 1158 <h4>Arguments</h4> 1159 <dl> 1160 <dt>o : network</dt> 1161 <dd>A D-Bus path to an object representing the added network.</dd> 1162 </dl> 1163 <dl> 1164 <dt>a{sv} : properties</dt> 1165 <dd>A dictionary containing properties of added network.</dd> 1166 </dl> 1167 </li> 1168 1169 <li> 1170 <h3>NetworkRemoved ( o : network )</h3> 1171 <p>The network has been removed from the interface.</p> 1172 <h4>Arguments</h4> 1173 <dl> 1174 <dt>o : network</dt> 1175 <dd>A D-Bus path to an object representing the removed network.</dd> 1176 </dl> 1177 </li> 1178 1179 <li> 1180 <h3>NetworkSelected ( o : network )</h3> 1181 <p>The network has been selected.</p> 1182 <h4>Arguments</h4> 1183 <dl> 1184 <dt>o : network</dt> 1185 <dd>A D-Bus path to an object representing the selected network.</dd> 1186 </dl> 1187 </li> 1188 1189 <li> 1190 <h3>StaAuthorized ( s : mac )</h3> 1191 <p>A new station has been authorized to the interface.</p> 1192 <h4>Arguments</h4> 1193 <dl> 1194 <dt>s : mac</dt> 1195 <dd>A mac address which has been authorized.</dd> 1196 </dl> 1197 </li> 1198 1199 <li> 1200 <h3>StaDeauthorized ( s : mac )</h3> 1201 <p>A station has been deauthorized to the interface.</p> 1202 <h4>Arguments</h4> 1203 <dl> 1204 <dt>s : mac</dt> 1205 <dd>A mac address which has been deauthorized.</dd> 1206 </dl> 1207 </li> 1208 1209 <li> 1210 <h3>StationAdded ( o : Station, a{sv} : properties )</h3> 1211 <p>A new station has been added to the interface.</p> 1212 <p>This signal complements StaAuthorized, passing the Station object and its properties.</p> 1213 <h4>Arguments</h4> 1214 <dl> 1215 <dt>o : Station</dt> 1216 <dd>A D-Bus path to an object representing the new Station.</dd> 1217 </dl> 1218 <dl> 1219 <dt>a{sv} : properties</dt> 1220 <dd>A dictionary containing properties of added Station.</dd> 1221 </dl> 1222 </li> 1223 1224 <li> 1225 <h3>StationRemoved ( o : Station )</h3> 1226 <p>The station has been removed from the interface.</p> 1227 <p>This signal complements StaDeauthorized, passing the Station object.</p> 1228 <h4>Arguments</h4> 1229 <dl> 1230 <dt>o : Station</dt> 1231 <dd>A D-Bus path to an object representing the Station.</dd> 1232 </dl> 1233 </li> 1234 1235 <li> 1236 <h3>PropertiesChanged ( a{sv} : properties )</h3> 1237 <p>Some properties have changed.</p> 1238 <h4>Arguments</h4> 1239 <dl> 1240 <dt>a{sv} : properties</dt> 1241 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ApScan", "Scanning", "State", "CurrentBSS", "CurrentNetwork"</dd> 1242 </dl> 1243 </li> 1244 1245 <li> 1246 <h3>Certification ( a{sv} : parameters )</h3> 1247 <p>Information about server TLS certificates.</p> 1248 <h4>Arguments</h4> 1249 <dl> 1250 <dt>a{sv} : parameters</dt> 1251 <dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "depth", "subject", "altsubject", "cert_hash", "cert".</dd> 1252 </dl> 1253 </li> 1254 1255 <li> 1256 <h3>EAP ( s : status, s : parameter )</h3> 1257 <p>Information about EAP peer status.</p> 1258 <h4>Arguments</h4> 1259 <dl> 1260 <dt>s : status</dt> 1261 <dd>Operation, e.g., "started", "accept proposed method", "remote certificate verification", "eap parameter needed", "completion".</dd> 1262 <dt>s : parameter</dt> 1263 <dd>Information about the operation, e.g., EAP method name, "success".</dd> 1264 </dl> 1265 </li> 1266 1267 <li> 1268 <h3>NetworkRequest ( o : network, s : field, s : txt )</h3> 1269 <p>Request for network parameter. NetworkResponse() is used to provide the requested parameter.</p> 1270 <h4>Arguments</h4> 1271 <dl> 1272 <dt>o : network</dt> 1273 <dd>D-Bus path to an object representing the network.</dd> 1274 <dt>s : field</dt> 1275 <dd>Requested information, e.g., "PASSWORD".</dd> 1276 <dt>txt : field</dt> 1277 <dd>Human readable information about the requested information.</dd> 1278 </dl> 1279 </li> 1280 1281 <li> 1282 <h3>ProbeRequest ( a{sv} : args )</h3> 1283 <p>Information about a received Probe Request frame. This signal is delivered only to a single application that has subscribed to received the events with SubscribeProbeReq().</p> 1284 <h4>Arguments</h4> 1285 <dl> 1286 <dt>a{sv} : args</dt> 1287 <dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "addr", "dst", "bssid", "ies", "signal".</dd> 1288 </dl> 1289 </li> 1290 1291 <li> 1292 <h3>InterworkingAPAdded ( o : bss, o : cred, a{sv} : args )</h3> 1293 </li> 1294 1295 <li> 1296 <h3>InterworkingSelectDone ( )</h3> 1297 </li> 1298 </ul> 1299 1300 1301\section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS 1302 1303Interface for performing WPS (Wi-Fi Simple Config) operations. 1304 1305\subsection dbus_wps_methods Methods 1306 1307<ul> 1308 <li> 1309 <h3>Start ( a{sv} : args ) --> a{sv} : output</h3> 1310 <p>Starts WPS configuration. Note: When used with P2P groups, this needs to be issued on the GO group interface.</p> 1311 <h4>Arguments</h4> 1312 <dl> 1313 <dt>a{sv} : args</dt> 1314 <dd> 1315 A dictionary with arguments used to start WPS configuration. The dictionary may contain the following entries: 1316 <table> 1317 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> 1318 <tr><td>Role</td><td>s</td><td>The device's role. Possible values are "enrollee" and "registrar".</td><td>Yes</td> 1319 <tr><td>Type</td><td>s</td><td>WPS authentication type. Applies only for enrollee role. Possible values are "pin" and "pbc".</td><td>Yes, for enrollee role; otherwise no</td> 1320 <tr><td>Pin</td><td>s</td><td>WPS Pin.</td><td>Yes, for registrar role; otherwise optional</td> 1321 <tr><td>Bssid</td><td>ay</td><td>Note: This is used to specify the peer MAC address when authorizing WPS connection in AP or P2P GO role.</td><td>No</td> 1322 <tr><td>P2PDeviceAddress</td><td>ay</td><td>P2P Device Address of a peer to authorize for PBC connection. Used only in P2P GO role.</td><td>No</td> 1323 </table> 1324 </dd> 1325 </dl> 1326 <h4>Returns</h4> 1327 <dl> 1328 <dt>a{sv} : output</dt> 1329 <dd> 1330 <table> 1331 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th> 1332 <tr><td>Pin</td><td>s</td><td>Newly generated PIN, if not specified for enrollee role and pin authentication type.</td><td>No</td> 1333 </table> 1334 </dd> 1335 </dl> 1336 <h4>Possible errors</h4> 1337 <dl> 1338 <dt>fi.w1.wpa_supplicant1.UnknownError</dt> 1339 <dd>Starting WPS configuration failed for an unknown reason.</dd> 1340 <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt> 1341 <dd>Invalid entries were found in the passed argument.</dd> 1342 </dl> 1343 </li> 1344 <li> 1345 <h3>Cancel ( nothing ) --> nothing</h3> 1346 <p>Cancel ongoing WPS operation.</p> 1347 </li> 1348 </ul> 1349 1350\subsection dbus_wps_properties Properties 1351 1352<ul> 1353 <li> 1354 <h3>ProcessCredentials - b - (read/write)</h3> 1355 <p>Determines if the interface will process the credentials (credentials_processed configuration file parameter).</p> 1356 </li> 1357 <li> 1358 <h3>ConfigMethods - s - (read/write)</h3> 1359 <p>The currently advertised WPS configuration methods. Available methods: usba ethernet label display ext_nfc_token int_nfc_token nfc_interface push_button keypad virtual_display physical_display virtual_push_button physical_push_button.</p> 1360 </li> 1361 <li> 1362 <h3>DeviceName - s - (read/write)</h3> 1363 <p>User-friendly description of device; up to 32 octets encoded in UTF-8.</p> 1364 </li> 1365 <li> 1366 <h3>Manufacturer - s - (read/write)</h3> 1367 <p>The manufacturer of the device (up to 64 ASCII characters).</p> 1368 </li> 1369 <li> 1370 <h3>ModelName - s - (read/write)</h3> 1371 <p>Model of the device (up to 32 ASCII characters).</p> 1372 </li> 1373 <li> 1374 <h3>ModelNumber - s - (read/write)</h3> 1375 <p>Additional device description (up to 32 ASCII characters).</p> 1376 </li> 1377 <li> 1378 <h3>SerialNumber - s - (read/write)</h3> 1379 <p>Serial number of the device (up to 32 characters).</p> 1380 </li> 1381 <li> 1382 <h3>DeviceType - ay - (read/write)</h3> 1383 <p>Device Type (8 octet value with 2 octet category, 4 octet OUI, 2 octet subcategory.</p> 1384 </li> 1385 </ul> 1386 1387\subsection dbus_wps_signals Signals 1388 1389<ul> 1390 <li> 1391 <h3>Event ( s : name, a{sv} : args )</h3> 1392 <p>WPS event occurred.</p> 1393 <h4>Arguments</h4> 1394 <dl> 1395 <dt>s : event</dt> 1396 <dd>Event type. Possible values are: "success, "fail", "m2d", and 1397 "pbc-overlap".</dd> 1398 <dt>a{sv} : args</dt> 1399 <dd> 1400 Event arguments. Empty for success and pbc-overlap events, error information ( "msg" : i, "config_error" : i, "error_indication" : i ) for fail event and following entries for m2d event: 1401 <table> 1402 <tr><th>config_methods</th><th>Value type</th> 1403 <tr><td>manufacturer</td><td>q</td> 1404 <tr><td>model_name</td><td>ay</td> 1405 <tr><td>model_number</td><td>ay</td> 1406 <tr><td>serial_number</td><td>ay</td> 1407 <tr><td>dev_name</td><td>ay</td> 1408 <tr><td>primary_dev_type</td><td>ay</td> 1409 <tr><td>config_error</td><td>q</td> 1410 <tr><td>dev_password_id</td><td>q</td> 1411 </table> 1412 </dd> 1413 </dl> 1414 </li> 1415 1416 <li> 1417 <h3>Credentials ( a{sv} : credentials )</h3> 1418 <p>WPS credentials. Dictionary contains:</p> 1419 <table> 1420 <tr><th>Key</th><th>Value type</th><th>Description</th> 1421 <tr><td>BSSID</td><td>ay</td><td></td> 1422 <tr><td>SSID</td><td>s</td><td></td> 1423 <tr><td>AuthType</td><td>as</td><td>Possible array elements: "open", "shared", "wpa-psk", "wpa-eap", "wpa2-eap", "wpa2-psk"</td> 1424 <tr><td>EncrType</td><td>as</td><td>Possible array elements: "none", "wep", "tkip", "aes"</td> 1425 <tr><td>Key</td><td>ay</td><td>Key data</td> 1426 <tr><td>KeyIndex</td><td>u</td><td>Key index</td> 1427 </table> 1428 </li> 1429 1430 <li> 1431 <h3>PropertiesChanged ( a{sv} : properties )</h3> 1432 <p>Some properties have changed.</p> 1433 <h4>Arguments</h4> 1434 <dl> 1435 <dt>a{sv} : properties</dt> 1436 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "ProcessCredentials"</dd> 1437 </dl> 1438 </li> 1439 </ul> 1440 1441 1442\section dbus_p2pdevice fi.w1.wpa_supplicant1.Interface.P2PDevice 1443 1444Interface for performing P2P (Wi-Fi Peer-to-Peer) P2P Device operations. 1445 1446\subsection dbus_p2pdevice_methods Methods 1447 1448<ul> 1449 <li> 1450 <h3>Find ( a{sv} : args ) --> nothing</h3> 1451 <p>Start P2P find operation (i.e., alternating P2P Search and Listen states to discover peers and be discoverable).</p> 1452 <h4>Arguments</h4> 1453 <dl> 1454 <dt>a{sv} : args</dt> 1455 <dd> 1456 A dictionary with parameters for the P2P find operation: 1457 <table> 1458 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1459 <tr><td>Timeout</td><td>i</td><td>Timeout for operating in seconds</td><td>no</td></tr> 1460 <tr><td>RequestedDeviceTypes</td><td>aay</td><td>WPS Device Types to search for</td><td>no</td></tr> 1461 <tr><td>DiscoveryType</td><td>s</td><td>"start_with_full" (default, if not specified), "social", "progressive"</td><td>no</td></tr> 1462 <tr><td>freq</td><td>i</td><td>Initial scan channel (frequency in MHz) for the start_with_full case to limit the initial scan to the specified channel</td><td>no</td></tr> 1463 </table> 1464 </dd> 1465 </dl> 1466 </li> 1467 1468 <li> 1469 <h3>StopFind ( nothing ) --> nothing</h3> 1470 <p>Stop P2P find operation.</p> 1471 </li> 1472 1473 <li> 1474 <h3>Listen ( i : timeout ) --> nothing</h3> 1475 <p>Start P2P listen operation (i.e., be discoverable).</p> 1476 <h4>Arguments</h4> 1477 <dl> 1478 <dt>i : timeout</dt> 1479 <dd>Timeout in seconds for stopping the listen operation.</dd> 1480 </dl> 1481 </li> 1482 1483 <li> 1484 <h3>ExtendedListen ( a{sv} : args ) --> nothing</h3> 1485 <p>Configure Extended Listen Timing. If the parameters are omitted, this feature is disabled. If the parameters are included, Listen State will be entered every interval msec for at least period msec. Both values have acceptable range of 1-65535 (with interval obviously having to be larger than or equal to duration). If the P2P module is not idle at the time the Extended Listen Timing timeout occurs, the Listen State operation will be skipped.</p> 1486 <h4>Arguments</h4> 1487 <dl> 1488 <dt>a{sv} : args</dt> 1489 <dd> 1490 A dictionary with parameters for extended listen. Leave out all items to disable extended listen. 1491 <table> 1492 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1493 <tr><td>period</td><td>i</td><td>Extended listen period in milliseconds; 1-65535.</td><td>no</td></tr> 1494 <tr><td>interval</td><td>i</td><td>Extended listen interval in milliseconds; 1-65535.</td><td>no</td></tr> 1495 </table> 1496 </dd> 1497 </dl> 1498 </li> 1499 1500 <li> 1501 <h3>PresenceRequest ( a{sv} : args ) --> nothing</h3> 1502 <p>Request a specific GO presence in a P2P group where the local device is a P2P Client. Send a P2P Presence Request to the GO (this is only available when acting as a P2P client). If no duration/interval pairs are given, the request indicates that this client has no special needs for GO presence. The first parameter pair gives the preferred duration and interval values in microseconds. If the second pair is included, that indicates which value would be acceptable. 1503 \note This needs to be issued on a P2P group interface if separate group interfaces are used. 1504 \bug It would be cleaner to not require .P2PDevice methods to be issued on a group interface. In other words, args['group_object'] could be used to specify the group or this method could be moved to be a .Group PresenceRequest() method.</p> 1505 <h4>Arguments</h4> 1506 <dl> 1507 <dt>a{sv} : args</dt> 1508 <dd> 1509 A dictionary with parameters for the presence request. 1510 <table> 1511 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1512 <tr><td>duration1</td><td>i</td><td>Duration in microseconds.</td><td>no</td></tr> 1513 <tr><td>interval1</td><td>i</td><td>Interval in microseconds.</td><td>no</td></tr> 1514 <tr><td>duration2</td><td>i</td><td>Duration in microseconds.</td><td>no</td></tr> 1515 <tr><td>interval2</td><td>i</td><td>Interval in microseconds.</td><td>no</td></tr> 1516 </table> 1517 </dd> 1518 </dl> 1519 </li> 1520 1521 <li> 1522 <h3>ProvisionDiscoveryRequest ( o : peer, s : config_method ) --> nothing</h3> 1523 </li> 1524 1525 <li> 1526 <h3>Connect ( a{sv} : args ) --> s : generated_pin</h3> 1527 <p>Request a P2P group to be started through GO Negotiation or by joining an already operating group.</p> 1528 <h4>Arguments</h4> 1529 <dl> 1530 <dt>a{sv} : args</dt> 1531 <dd> 1532 A dictionary with parameters for the requested connection: 1533 <table> 1534 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1535 <tr><td>peer</td><td>o</td><td></td><td>yes</td></tr> 1536 <tr><td>persistent</td><td>b</td><td>Whether to form a persistent group.</td><td>no</td></tr> 1537 <tr><td>join</td><td>b</td><td>Whether to join an already operating group instead of forming a new group.</td><td>no</td></tr> 1538 <tr><td>authorize_only</td><td>b</td><td>Whether to authorize a peer to initiate GO Negotiation instead of initiating immediately.</td><td>no</td></tr> 1539 <tr><td>frequency</td><td>i</td><td>Operating frequency in MHz</td><td>no</td></tr> 1540 <tr><td>go_intent</td><td>i</td><td>GO intent 0-15</td><td>no</td></tr> 1541 <tr><td>wps_method</td><td>s</td><td>"pbc", "display", "keypad", "pin" (alias for "display")</td><td>yes</td></tr> 1542 <tr><td>pin</td><td>s</td><td></td><td>no</td></tr> 1543 </table> 1544 </dd> 1545 </dl> 1546 </li> 1547 1548 <li> 1549 <h3>GroupAdd ( a{sv} : args ) --> nothing</h3> 1550 <p>Request a P2P group to be started without GO Negotiation.</p> 1551 <h4>Arguments</h4> 1552 <dl> 1553 <dt>a{sv} : args</dt> 1554 <dd> 1555 A dictionary with parameters for the requested group: 1556 <table> 1557 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1558 <tr><td>persistent</td><td>b</td><td>Whether to form a persistent group.</td><td>no</td></tr> 1559 <tr><td>persistent_group_object</td><td>o</td><td></td><td>no</td></tr> 1560 <tr><td>frequency</td><td>i</td><td>Operating frequency in MHz</td><td>no</td></tr> 1561 </table> 1562 </dd> 1563 </dl> 1564 </li> 1565 1566 <li> 1567 <h3>Cancel ( nothing ) --> nothing</h3> 1568 <p>Stop ongoing P2P group formation operation.</p> 1569 </li> 1570 1571 <li> 1572 <h3>Invite ( a{sv} : args ) --> nothing</h3> 1573 <p>Invite a peer to join an already operating group or to re-invoke a persistent group.</p> 1574 <h4>Arguments</h4> 1575 <dl> 1576 <dt>a{sv} : args</dt> 1577 <dd> 1578 A dictionary with parameters for the invitation: 1579 <table> 1580 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1581 <tr><td>peer</td><td>o</td><td></td><td>yes</td></tr> 1582 <tr><td>persistent_group_object</td><td>o</td><td></td><td>no</td></tr> 1583 </table> 1584 </dd> 1585 </dl> 1586 </li> 1587 1588 <li> 1589 <h3>Disconnect ( nothing ) --> nothing</h3> 1590 <p>Terminate a P2P group. 1591 \note This needs to be issued on a P2P group interface if separate group interfaces are used. 1592 \bug It would be cleaner to not require .P2PDevice methods to be issued on a group interface. In other words, this would either need to be Disconnect(group_object) or moved to be a .Group Disconnect() method.</p> 1593 </li> 1594 1595 <li> 1596 <h3>RejectPeer ( o : peer ) --> nothing</h3> 1597 <p>Reject connection attempt from a peer (specified with a device address). This is a mechanism to reject a pending GO Negotiation with a peer and request to automatically block any further connection or discovery of the peer.</p> 1598 </li> 1599 1600 <li> 1601 <h3>RemoveClient ( a{sv} : args ) --> nothing</h3> 1602 <p>Remove the client from all groups (operating and persistent) from the local GO.</p> 1603 <h4>Arguments</h4> 1604 <dl> 1605 <dt>a{sv} : args</dt> 1606 <dd> 1607 A dictionary with parameters for removing a client: 1608 <table> 1609 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1610 <tr><td>peer</td><td>o</td><td>Object path for peer's P2P Device Address</td><td>yes</td></tr> 1611 <tr><td>iface</td><td>s</td><td>Interface address[MAC Address format] of the peer to be disconnected. Required if object path is not provided.</td><td>no</td></tr> 1612 </table> 1613 </dd> 1614 </dl> 1615 </li> 1616 1617 <li> 1618 <h3>Flush ( nothing ) --> nothing</h3> 1619 <p>Flush P2P peer table and state.</p> 1620 </li> 1621 1622 <li> 1623 <h3>AddService ( a{sv} : args ) --> nothing</h3> 1624 <p></p> 1625 <h4>Arguments</h4> 1626 <dl> 1627 <dt>a{sv} : args</dt> 1628 <dd> 1629 A dictionary with parameters for the service: 1630 <table> 1631 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1632 <tr><td>service_type</td><td>s</td><td>"upnp", "bonjour"</td><td>yes</td></tr> 1633 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr> 1634 <tr><td>service</td><td>s</td><td></td><td></td></tr> 1635 <tr><td>query</td><td>ay</td><td></td><td></td></tr> 1636 <tr><td>response</td><td>ay</td><td></td><td></td></tr> 1637 </table> 1638 </dd> 1639 </dl> 1640 </li> 1641 1642 <li> 1643 <h3>DeleteService ( a{sv} : args ) --> nothing</h3> 1644 <p></p> 1645 <h4>Arguments</h4> 1646 <dl> 1647 <dt>a{sv} : args</dt> 1648 <dd> 1649 A dictionary with parameters for the service: 1650 <table> 1651 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1652 <tr><td>service_type</td><td>s</td><td>"upnp", "bonjour"</td><td>yes</td></tr> 1653 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr> 1654 <tr><td>service</td><td>s</td><td></td><td></td></tr> 1655 <tr><td>query</td><td>ay</td><td></td><td></td></tr> 1656 </table> 1657 </dd> 1658 </dl> 1659 </li> 1660 1661 <li> 1662 <h3>FlushService ( nothing ) --> nothing</h3> 1663 </li> 1664 1665 <li> 1666 <h3>ServiceDiscoveryRequest ( a{sv} : args ) --> t : ref</h3> 1667 <p></p> 1668 <h4>Arguments</h4> 1669 <dl> 1670 <dt>a{sv} : args</dt> 1671 <dd> 1672 A dictionary with following parameters: 1673 <table> 1674 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1675 <tr><td>peer_object</td><td>o</td><td></td><td>no</td></tr> 1676 <tr><td>service_type</td><td>s</td><td>"upnp"</td><td>no</td></tr> 1677 <tr><td>version</td><td>u</td><td>Required for UPnP services.</td><td>no</td></tr> 1678 <tr><td>service</td><td>s</td><td></td><td></td></tr> 1679 <tr><td>tlv</td><td>ay</td><td></td><td></td></tr> 1680 </table> 1681 </dd> 1682 </dl> 1683 </li> 1684 1685 <li> 1686 <h3>ServiceDiscoveryResponse ( a{sv} : args ) --> nothing : ref</h3> 1687 <p></p> 1688 <h4>Arguments</h4> 1689 <dl> 1690 <dt>a{sv} : args</dt> 1691 <dd> 1692 A dictionary with following parameters: 1693 <table> 1694 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1695 <tr><td>peer_object</td><td>o</td><td></td><td>yes</td></tr> 1696 <tr><td>frequency</td><td>i</td><td></td><td>yes</td></tr> 1697 <tr><td>dialog_token</td><td>i</td><td></td><td>yes</td></tr> 1698 <tr><td>tlvs</td><td>ay</td><td></td><td>yes</td></tr> 1699 </table> 1700 </dd> 1701 </dl> 1702 </li> 1703 1704 <li> 1705 <h3>ServiceDiscoveryCancelRequest ( t : args ) --> nothing : ref</h3> 1706 </li> 1707 1708 <li> 1709 <h3>ServiceUpdate ( nothing ) --> nothing</h3> 1710 </li> 1711 1712 <li> 1713 <h3>ServiceDiscoveryExternal ( i : arg ) --> nothing</h3> 1714 </li> 1715 1716 <li> 1717 <h3>AddPersistentGroup ( a{sv} : args ) --> o : path</h3> 1718 <p></p> 1719 <h4>Arguments</h4> 1720 <dl> 1721 <dt>a{sv} : args</dt> 1722 <dd> 1723 A dictionary with following parameters: 1724 <table> 1725 <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr> 1726 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td><td>yes</td></tr> 1727 <tr><td>ssid</td><td>s</td><td>SSID of the group</td><td>yes</td></tr> 1728 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td><td>yes</td></tr> 1729 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td><td>yes</td></tr> 1730 </table> 1731 </dd> 1732 </dl> 1733 </li> 1734 1735 <li> 1736 <h3>RemovePersistentGroup ( o : path ) --> nothing</h3> 1737 </li> 1738 1739 <li> 1740 <h3>RemoveAllPersistentGroups ( nothing ) --> nothing</h3> 1741 </li> 1742</ul> 1743 1744\subsection dbus_p2pdevice_properties Properties 1745 1746<ul> 1747 <li> 1748 <h3>P2PDeviceConfig - a{sv} - (read/write)</h3> 1749 <p>Dictionary with following entries. On write, only the included values are changed.</p> 1750 <table> 1751 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1752 <tr><td>DeviceName</td><td>s</td><td></td></tr> 1753 <tr><td>PrimaryDeviceType</td><td>ay</td><td></td></tr> 1754 <tr><td>SecondaryDeviceTypes</td><td>aay</td><td></td></tr> 1755 <tr><td>VendorExtension</td><td>aay</td><td></td></tr> 1756 <tr><td>GOIntent</td><td>u</td><td></td></tr> 1757 <tr><td>PersistentReconnect</td><td>b</td><td></td></tr> 1758 <tr><td>ListenRegClass</td><td>u</td><td></td></tr> 1759 <tr><td>ListenChannel</td><td>u</td><td></td></tr> 1760 <tr><td>OperRegClass</td><td>u</td><td></td></tr> 1761 <tr><td>OperChannel</td><td>u</td><td></td></tr> 1762 <tr><td>SsidPostfix</td><td>s</td><td></td></tr> 1763 <tr><td>IntraBss</td><td>b</td><td></td></tr> 1764 <tr><td>GroupIdle</td><td>u</td><td></td></tr> 1765 <tr><td>disassoc_low_ack</td><td>u</td><td></td></tr> 1766 <tr><td>NoGroupIface</td><td>b</td><td></td></tr> 1767 <tr><td>p2p_search_delay</td><td>u</td><td></td></tr> 1768 </table> 1769 </li> 1770 1771 <li> 1772 <h3>Peers - ao - (read)</h3> 1773 </li> 1774 1775 <li> 1776 <h3>Role - s - (read)</h3> 1777 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property role since there can be multiple concurrent groups and the P2P Device role is always active anyway.</p> 1778 </li> 1779 1780 <li> 1781 <h3>Group - o - (read)</h3> 1782 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property Group since there can be multiple concurrent groups.</p> 1783 </li> 1784 1785 <li> 1786 <h3>PeerGO - o - (read)</h3> 1787 <p>\bug What is this trying to indicate? It does not make much sense to have a P2PDevice property PeerGO since there can be multiple concurrent groups.</p> 1788 </li> 1789 1790 <li> 1791 <h3>PersistentGroups - ao - (read)</h3> 1792 </li> 1793</ul> 1794 1795\subsection dbus_p2pdevice_signals Signals 1796 1797<ul> 1798 <li> 1799 <h3>DeviceFound ( o : path )</h3> 1800 </li> 1801 1802 <li> 1803 <h3>DeviceFoundProperties ( o : path, a{sv} : properties )</h3> 1804 <p>A new peer device has been found.</p> 1805 <h4>Arguments</h4> 1806 <dl> 1807 <dt>o : path</dt> 1808 <dd>A D-Bus path to an object representing the found peer device.</dd> 1809 </dl> 1810 <dl> 1811 <dt>a{sv} : properties</dt> 1812 <dd>A dictionary containing properties of the found peer device.</dd> 1813 </dl> 1814 </li> 1815 1816 <li> 1817 <h3>DeviceLost ( o : path )</h3> 1818 </li> 1819 1820 <li> 1821 <h3>FindStopped ( )</h3> 1822 </li> 1823 1824 <li> 1825 <h3>ProvisionDiscoveryRequestDisplayPin ( o : peer_object, s : pin )</h3> 1826 </li> 1827 1828 <li> 1829 <h3>ProvisionDiscoveryResponseDisplayPin ( o : peer_object, s : pin )</h3> 1830 </li> 1831 1832 <li> 1833 <h3>ProvisionDiscoveryRequestEnterPin ( o : peer_object )</h3> 1834 </li> 1835 1836 <li> 1837 <h3>ProvisionDiscoveryResponseEnterPin ( o : peer_object )</h3> 1838 </li> 1839 1840 <li> 1841 <h3>ProvisionDiscoveryPBCRequest ( o : peer_object )</h3> 1842 </li> 1843 1844 <li> 1845 <h3>ProvisionDiscoveryPBCResponse ( o : peer_object )</h3> 1846 </li> 1847 1848 <li> 1849 <h3>ProvisionDiscoveryFailure ( o : peer_object, i : status )</h3> 1850 </li> 1851 1852 <li> 1853 <h3>GroupStarted ( a{sv} : properties )</h3> 1854 <p>A new P2P group was started or joined.</p> 1855 <h4>Arguments</h4> 1856 <dl> 1857 <dt>a{sv} : properties</dt> 1858 <dd>A dictionary with following information on the added group: 1859 <table> 1860 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1861 <tr><td>interface_object</td><td>o</td><td>D-Bus path of the interface on which this group is operating on. See \ref dbus_interface.</td></tr> 1862 <tr><td>role</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr> 1863 <tr><td>group_object</td><td>o</td><td>D-Bus path of the group. See \ref dbus_group.</td></tr> 1864 </table> 1865 </dd> 1866 </dl> 1867 </li> 1868 1869 <li> 1870 <h3>GONegotiationSuccess ( a{sv} : properties )</h3> 1871 <p></p> 1872 <h4>Arguments</h4> 1873 <dl> 1874 <dt>a{sv} : properties</dt> 1875 <dd>A dictionary with following information: 1876 <table> 1877 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1878 <tr><td>peer_object</td><td>o</td><td>D-Bus path of the peer. See \ref dbus_peer.</td></tr> 1879 <tr><td>status</td><td>i</td><td></td></tr> 1880 <tr><td>passphrase</td><td>s</td><td>Passphrase for the group. Included only if this device becomes the GO of the group.</td></tr> 1881 <tr><td>role_go</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr> 1882 <tr><td>ssid</td><td>ay</td><td></td></tr> 1883 <tr><td>peer_device_addr</td><td>ay</td><td></td></tr> 1884 <tr><td>peer_interface_addr</td><td>ay</td><td></td></tr> 1885 <tr><td>wps_method</td><td>s</td><td></td></tr> 1886 <tr><td>frequency_list</td><td>ai</td><td></td></tr> 1887 <tr><td>persistent_group</td><td>i</td><td></td></tr> 1888 <tr><td>peer_config_timeout</td><td>u</td><td></td></tr> 1889 </table> 1890 </dd> 1891 </dl> 1892 </li> 1893 1894 <li> 1895 <h3>GONegotiationFailure ( a{sv} : properties )</h3> 1896 <p></p> 1897 <h4>Arguments</h4> 1898 <dl> 1899 <dt>a{sv} : properties</dt> 1900 <dd>A dictionary with following information: 1901 <table> 1902 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1903 <tr><td>peer_object</td><td>o</td><td>D-Bus path of the peer. See \ref dbus_peer.</td></tr> 1904 <tr><td>status</td><td>i</td><td></td></tr> 1905 </table> 1906 </dd> 1907 </dl> 1908 </li> 1909 1910 <li> 1911 <h3>GONegotiationRequest ( o : path, q : dev_passwd_id, y : device_go_intent )</h3> 1912 </li> 1913 1914 <li> 1915 <h3>InvitationResult ( a{sv} : invite_result )</h3> 1916 <p></p> 1917 <h4>Arguments</h4> 1918 <dl> 1919 <dt>a{sv} : invite_result</dt> 1920 <dd>A dictionary with following information: 1921 <table> 1922 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1923 <tr><td>status</td><td>i</td><td></td></tr> 1924 <tr><td>BSSID</td><td>ay</td><td>Optionally present</td></tr> 1925 </table> 1926 </dd> 1927 </dl> 1928 </li> 1929 1930 <li> 1931 <h3>GroupFinished ( a{sv} : properties )</h3> 1932 <p>A P2P group was removed.</p> 1933 <h4>Arguments</h4> 1934 <dl> 1935 <dt>a{sv} : properties</dt> 1936 <dd>A dictionary with following information of the removed group: 1937 <table> 1938 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1939 <tr><td>interface_object</td><td>o</td><td>D-Bus path of the interface on which this group is operating on. See \ref dbus_interface.</td></tr> 1940 <tr><td>role</td><td>s</td><td>The role of the local device in the group: "GO" or "client".</td></tr> 1941 <tr><td>group_object</td><td>o</td><td>D-Bus path of the group. See \ref dbus_group.</td></tr> 1942 </table> 1943 </dd> 1944 </dl> 1945 </li> 1946 1947 <li> 1948 <h3>ServiceDiscoveryRequest ( a{sv} : sd_request )</h3> 1949 <p></p> 1950 <h4>Arguments</h4> 1951 <dl> 1952 <dt>a{sv} : sd_request</dt> 1953 <dd>A dictionary with following information: 1954 <table> 1955 <tr><td>peer_object</td><td>o</td><td></td></tr> 1956 <tr><td>frequency</td><td>i</td><td></td></tr> 1957 <tr><td>dialog_token</td><td>i</td><td></td></tr> 1958 <tr><td>update_indicator</td><td>q</td><td></td></tr> 1959 <tr><td>tlvs</td><td>ay</td><td></td></tr> 1960 </table> 1961 </dd> 1962 </dl> 1963 </li> 1964 1965 <li> 1966 <h3>ServiceDiscoveryResponse ( a{sv} : sd_response )</h3> 1967 <p></p> 1968 <h4>Arguments</h4> 1969 <dl> 1970 <dt>a{sv} : sd_response</dt> 1971 <dd>A dictionary with following information: 1972 <table> 1973 <tr><td>peer_object</td><td>o</td><td></td></tr> 1974 <tr><td>update_indicator</td><td>q</td><td></td></tr> 1975 <tr><td>tlvs</td><td>ay</td><td></td></tr> 1976 </table> 1977 </dd> 1978 </dl> 1979 </li> 1980 1981 <li> 1982 <h3>PersistentGroupAdded ( o : path, a{sv} : properties )</h3> 1983 <p></p> 1984 <h4>Arguments</h4> 1985 <dl> 1986 <dt>o : path</dt> 1987 <dd>D-Bus object path for the persistent group. See \ref dbus_persistent_group.</dd> 1988 <dt>a{sv} : properties</dt> 1989 <dd>A dictionary with following information: 1990 <table> 1991 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 1992 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td></tr> 1993 <tr><td>ssid</td><td>s</td><td>SSID of the group</td></tr> 1994 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td></tr> 1995 <tr><td>disabled</td><td>s</td><td>Set to "2" to indicate special network block use as a P2P persistent group information</td></tr> 1996 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td></tr> 1997 </table> 1998 </dd> 1999 </dl> 2000 </li> 2001 2002 <li> 2003 <h3>PersistentGroupRemoved ( o : path )</h3> 2004 <p></p> 2005 <h4>Arguments</h4> 2006 <dl> 2007 <dt>o : path</dt> 2008 <dd>D-Bus object path for the persistent group. See \ref dbus_persistent_group.</dd> 2009 </dl> 2010 </li> 2011 2012 <li> 2013 <h3>WpsFailed ( s : name, a{sv} : args )</h3> 2014 <p></p> 2015 <h4>Arguments</h4> 2016 <dl> 2017 <dt>s : name</dt> 2018 <dd>"fail"</dd> 2019 <dt>a{sv} : args</dt> 2020 <dd>A dictionary with following information: 2021 <table> 2022 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 2023 <tr><td>msg</td><td>i</td><td></td></tr> 2024 <tr><td>config_error</td><td>n</td><td></td></tr> 2025 </table> 2026 </dd> 2027 </dl> 2028 </li> 2029 2030 <li> 2031 <h3>InvitationReceived ( a{sv} : properties )</h3> 2032 <p></p> 2033 <h4>Arguments</h4> 2034 <dl> 2035 <dt>a{sv} : properties</dt> 2036 <dd>A dictionary with following information: 2037 <table> 2038 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 2039 <tr><td>sa</td><td>ay</td><td>Optionally present</td></tr> 2040 <tr><td>go_dev_addr</td><td>ay</td><td>Optionally present</td></tr> 2041 <tr><td>bssid</td><td>ay</td><td>Optionally present</td></tr> 2042 <tr><td>persistent_id</td><td>i</td><td>Optionally present</td></tr> 2043 <tr><td>op_freq</td><td>i</td><td></td></tr> 2044 </table> 2045 </dd> 2046 </dl> 2047 </li> 2048 2049 <li> 2050 <h3>GroupFormationFailure ( s : reason )</h3> 2051 <p></p> 2052 <h4>Arguments</h4> 2053 <dl> 2054 <dt>s : reason</dt> 2055 <dd>Reason for failure or empty string if not known.</dd> 2056 </dl> 2057 </li> 2058</ul> 2059 2060\section dbus_bss fi.w1.wpa_supplicant1.BSS 2061 2062Interface implemented by objects representing a scanned BSSs, i.e., 2063scan results. 2064 2065\subsection dbus_bss_properties Properties 2066 2067<ul> 2068 <li> 2069 <h3>BSSID - ay - (read)</h3> 2070 <p>BSSID of the BSS.</p> 2071 </li> 2072 <li> 2073 <h3>SSID - ay - (read)</h3> 2074 <p>SSID of the BSS.</p> 2075 </li> 2076 <li> 2077 <h3>WPA - a{sv} - (read)</h3> 2078 <p>WPA information of the BSS. Empty dictionary indicates no WPA support. Dictionary entries are:</p> 2079 <table> 2080 <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-none"</td> 2081 <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td> 2082 <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td> 2083 </table> 2084 </li> 2085 <li> 2086 <h3>RSN - a{sv} - (read)</h3> 2087 <p>RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:</p> 2088 <table> 2089 <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "wpa-eap-suite-b", "wpa-eap-suite-b-192", "wpa-fils-sha256", "wpa-fils-sha384", "wpa-ft-fils-sha256", "wpa-ft-fils-sha384", "sae", "ft-sae", "wpa-none"</td> 2090 <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td> 2091 <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td> 2092 <tr><td>MgmtGroup</td><td>s</td><td>Management frames cipher suite. Possible values are: "aes128cmac"</td> 2093 </table> 2094 </li> 2095 <li> 2096 <h3>WPS - a{sv} - (read)</h3> 2097 <p>WPS information of the BSS. Empty dictionary indicates no WPS support. Dictionary entries are:</p> 2098 <table> 2099 <tr><td>Type</td><td>s</td><td>"pbc", "pin", ""</td> 2100 </table> 2101 </li> 2102 <li> 2103 <h3>IEs - ay - (read)</h3> 2104 <p>All IEs of the BSS as a chain of TLVs</p> 2105 </li> 2106 <li> 2107 <h3>Privacy - b - (read)</h3> 2108 <p>Indicates if BSS supports privacy.</p> 2109 </li> 2110 <li> 2111 <h3>Mode - s - (read)</h3> 2112 <p>Describes mode of the BSS. Possible values are: "ad-hoc" and "infrastructure".</p> 2113 </li> 2114 <li> 2115 <h3>Frequency - q - (read)</h3> 2116 <p>Frequency of the BSS in MHz.</p> 2117 </li> 2118 <li> 2119 <h3>Rates - au - (read)</h3> 2120 <p>Descending ordered array of rates supported by the BSS in bits per second.</p> 2121 </li> 2122 <li> 2123 <h3>Signal - n - (read)</h3> 2124 <p>Signal strength of the BSS.</p> 2125 </li> 2126 <li> 2127 <h3>Age - u - (read)</h3> 2128 <p>Number of seconds since the BSS was last seen.</p> 2129 </li> 2130 </ul> 2131 2132\subsection dbus_bss_signals Signals 2133 2134<ul> 2135 <li> 2136 <h3>PropertiesChanged ( a{sv} : properties )</h3> 2137 <p>Some properties have changed.</p> 2138 <h4>Arguments</h4> 2139 <dl> 2140 <dt>a{sv} : properties</dt> 2141 <dd>A dictionary with pairs of properties names which have changed and theirs new values.</dd> 2142 </dl> 2143 </li> 2144 </ul> 2145 2146 2147\section dbus_network fi.w1.wpa_supplicant1.Network 2148 2149Interface implemented by objects representing configured networks, 2150i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork. 2151 2152\subsection dbus_network_properties Properties 2153 2154<ul> 2155 <li> 2156 <h3>Enabled - b - (read/write)</h3> 2157 <p>Determines if the configured network is enabled or not.</p> 2158 </li> 2159 2160 <li> 2161 <h3>Properties - a{sv} - (read/write)</h3> 2162 <p>Properties of the configured network. Dictionary contains entries from "network" block of wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437. When setting the properties, use the same format as for the AddNetwork() function.</p> 2163 </li> 2164 </ul> 2165 2166\subsection dbus_network_signals Signals 2167 2168<ul> 2169 <li> 2170 <h3>PropertiesChanged ( a{sv} : properties )</h3> 2171 <p>Some properties have changed.</p> 2172 <h4>Arguments</h4> 2173 <dl> 2174 <dt>a{sv} : properties</dt> 2175 <dd>A dictionary with pairs of properties names which have changed and theirs new values. Possible dictionary keys are: "Enabled"</dd> 2176 </dl> 2177 </li> 2178 </ul> 2179 2180\section dbus_peer fi.w1.wpa_supplicant1.Peer 2181 2182Interface implemented by objects representing P2P peer devices. 2183 2184\subsection dbus_peer_properties Properties 2185 2186<ul> 2187 <li> 2188 <h3>DeviceName - s - (read)</h3> 2189 </li> 2190 2191 <li> 2192 <h3>Manufacturer - s - (read)</h3> 2193 </li> 2194 2195 <li> 2196 <h3>ModelName - s - (read)</h3> 2197 </li> 2198 2199 <li> 2200 <h3>ModelNumber - s - (read)</h3> 2201 </li> 2202 2203 <li> 2204 <h3>SerialNumber - s - (read)</h3> 2205 </li> 2206 2207 <li> 2208 <h3>PrimaryDeviceType - ay - (read)</h3> 2209 </li> 2210 2211 <li> 2212 <h3>config_method - q - (read)</h3> 2213 </li> 2214 2215 <li> 2216 <h3>level - i - (read)</h3> 2217 </li> 2218 2219 <li> 2220 <h3>devicecapability - y - (read)</h3> 2221 </li> 2222 2223 <li> 2224 <h3>groupcapability - y - (read)</h3> 2225 <p>Group Capability field from the last frame from which this peer information was updated. 2226 \note This field is only for debugging purposes and must not be used to determine whether the peer happens to be operating a group as a GO at the moment. 2227 </p> 2228 </li> 2229 2230 <li> 2231 <h3>SecondaryDeviceTypes - aay - (read)</h3> 2232 </li> 2233 2234 <li> 2235 <h3>VendorExtension - aay - (read)</h3> 2236 </li> 2237 2238 <li> 2239 <h3>IEs - ay - (read)</h3> 2240 <p>This is a confusingly named property that includes Wi-Fi Display subelements from the peer. 2241 \bug This should really be renamed since "IEs" means something completely different.. 2242 </p> 2243 </li> 2244 2245 <li> 2246 <h3>DeviceAddress - ay - (read)</h3> 2247 <p>The P2P Device Address of the peer.</p> 2248 </li> 2249 2250 <li> 2251 <h3>Groups - ao - (read)</h3> 2252 <p>The current groups in which this peer is connected.</p> 2253 </li> 2254</ul> 2255 2256\subsection dbus_peer_signals Signals 2257 2258<ul> 2259 <li> 2260 <h3>PropertiesChanged ( a{sv} : properties )</h3> 2261 <p>Some properties have changed. 2262 \deprecated Use org.freedesktop.DBus.Properties.PropertiesChanged instead.</p> 2263 \todo Explain how ProertiesChanged signals are supposed to be of any real use with Peer objects (i.e., one signal for multiple peers). 2264 <h4>Arguments</h4> 2265 <dl> 2266 <dt>a{sv} : properties</dt> 2267 <dd>A dictionary with pairs of properties names which have changed and their new values.</dd> 2268 </dl> 2269 </li> 2270 </ul> 2271 2272\section dbus_group fi.w1.wpa_supplicant1.Group 2273 2274Interface implemented by objects representing active P2P groups. 2275 2276\subsection dbus_group_properties Properties 2277 2278<ul> 2279 <li> 2280 <h3>Members - ao - (read)</h3> 2281 <p>Array of D-Bus object paths for the peer devices that are currently connected to the group. This is valid only on the GO device. An empty array is returned in P2P Client role. 2282 </li> 2283 2284 <li> 2285 <h3>Group - o - (read)</h3> 2286 <p>\todo Why is this here? This D-Bus object path is to this specific group and one needs to know it to fetching this information in the first place.. 2287 </p> 2288 </li> 2289 2290 <li> 2291 <h3>Role - s - (read)</h3> 2292 <p>The role of this device in the group: "GO", "client".</p> 2293 </li> 2294 2295 <li> 2296 <h3>SSID - ay - (read)</h3> 2297 <p>P2P Group SSID.</p> 2298 </li> 2299 2300 <li> 2301 <h3>BSSID - ay - (read)</h3> 2302 <p>P2P Group BSSID (the P2P Interface Address of the GO).</p> 2303 </li> 2304 2305 <li> 2306 <h3>Frequency - q - (read)</h3> 2307 <p>The frequency (in MHz) of the group operating channel.</p> 2308 </li> 2309 2310 <li> 2311 <h3>Passphrase - s - (read)</h3> 2312 <p>Passphrase used in the group. This is always available on the GO. For P2P Client role, this may be available depending on whether the peer GO provided the passphrase during the WPS provisioning step. If not available, an empty string is returned.</p> 2313 </li> 2314 2315 <li> 2316 <h3>PSK - ay - (read)</h3> 2317 <p>PSK used in the group.</p> 2318 </li> 2319 2320 <li> 2321 <h3>WPSVendorExtensions - aay - (read/write)</h3> 2322 <p>WPS vendor extension attributes used on the GO. This is valid only the in the GO role. An empty array is returned in P2P Client role. At maximum, 10 separate vendor extension byte arrays can be configured. The GO device will include the configured attributes in WPS exchanges.</p> 2323 </li> 2324</ul> 2325 2326\subsection dbus_group_signals Signals 2327 2328<ul> 2329 <li> 2330 <h3>PeerJoined ( o : peer )</h3> 2331 <p>A peer device has joined the group. This is indicated only on the GO device.</p> 2332 <h4>Arguments</h4> 2333 <dl> 2334 <dt>o : peer</dt> 2335 <dd>A D-Bus path to the object representing the peer. See \ref dbus_peer.</dd> 2336 </dl> 2337 </li> 2338 2339 <li> 2340 <h3>PeerDisconnected ( o : peer )</h3> 2341 <p>A peer device has left the group. This is indicated only on the GO device.</p> 2342 <h4>Arguments</h4> 2343 <dl> 2344 <dt>o : peer</dt> 2345 <dd>A D-Bus path to the object representing the peer. See \ref dbus_peer.</dd> 2346 </dl> 2347 </li> 2348</ul> 2349 2350\section dbus_persistent_group fi.w1.wpa_supplicant1.PersistentGroup 2351 2352Interface implemented by objects representing persistent P2P groups. 2353 2354\subsection dbus_persistent_group_properties Properties 2355 2356<ul> 2357 <li> 2358 <h3>Properties - a{sv} - (read/write)</h3> 2359 <p>Properties of the persistent group. These are same properties as in the \ref dbus_network. When writing this, only the entries to be modified are included, i.e., any item that is not included will be left at its existing value. The following entries are used for persistent groups:</p> 2360 <table> 2361 <tr><th>Key</th><th>Value type</th><th>Description</th></tr> 2362 <tr><td>bssid</td><td>s</td><td>P2P Device Address of the GO in the persistent group.</td></tr> 2363 <tr><td>ssid</td><td>s</td><td>SSID of the group</td></tr> 2364 <tr><td>psk</td><td>s</td><td>Passphrase (on the GO and optionally on P2P Client) or PSK (on P2P Client if passphrase ise not known)</td></tr> 2365 <tr><td>disabled</td><td>s</td><td>Set to "2" to indicate special network block use as a P2P persistent group information</td></tr> 2366 <tr><td>mode</td><td>s</td><td>"3" on GO or "0" on P2P Client</td></tr> 2367 </table> 2368 </li> 2369</ul> 2370 2371\section dbus_mesh fi.w1.wpa_supplicant1.Interface.Mesh 2372 2373Interface for performing mesh operations. 2374 2375\subsection dbus_mesh_properties Properties 2376 2377<ul> 2378 <li> 2379 <h3>MeshPeers - aay - (read)</h3> 2380 </li> 2381 2382 <li> 2383 <h3>MeshGroup - ay - (read)</h3> 2384 </li> 2385</ul> 2386 2387\subsection dbus_mesh_signals Signals 2388 2389<ul> 2390 <li> 2391 <h3>MeshGroupStarted ( a{sv} : args )</h3> 2392 <p></p> 2393 <h4>Arguments</h4> 2394 <dl> 2395 <dt>a{sv} : args</dt> 2396 <dd>A dictionary containing information of the started mesh group.</dd> 2397 </dl> 2398 </li> 2399 <li> 2400 <h3>MeshGroupRemoved ( a{sv} : args )</h3> 2401 <p></p> 2402 <h4>Arguments</h4> 2403 <dl> 2404 <dt>a{sv} : args</dt> 2405 <dd>A dictionary containing information of the removed mesh group.</dd> 2406 </dl> 2407 </li> 2408 <li> 2409 <h3>MeshPeerConnected ( a{sv} : args )</h3> 2410 <p></p> 2411 <h4>Arguments</h4> 2412 <dl> 2413 <dt>a{sv} : args</dt> 2414 <dd>A dictionary containing information of the connected mesh peer.</dd> 2415 </dl> 2416 </li> 2417 <li> 2418 <h3>MeshPeerDisconnected ( a{sv} : args )</h3> 2419 <p></p> 2420 <h4>Arguments</h4> 2421 <dl> 2422 <dt>a{sv} : args</dt> 2423 <dd>A dictionary containing information of the disconnected mesh peer.</dd> 2424 </dl> 2425 </li> 2426</ul> 2427 2428*/ 2429
