doc/PLCAPI.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >PlanetLab Central API Documentation</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
   9 ><BODY
  10 CLASS="book"
  11 BGCOLOR="#FFFFFF"
  12 TEXT="#000000"
  13 LINK="#0000FF"
  14 VLINK="#840084"
  15 ALINK="#0000FF"
  16 ><DIV
  17 CLASS="BOOK"
  18 ><A
  19 NAME="AEN1"
  20 ></A
  21 ><DIV
  22 CLASS="TITLEPAGE"
  23 ><H1
  24 CLASS="title"
  25 ><A
  26 NAME="AEN2"
  27 >PlanetLab Central API Documentation</A
  28 ></H1
  29 ><HR></DIV
  30 ><DIV
  31 CLASS="TOC"
  32 ><DL
  33 ><DT
  34 ><B
  35 >Table of Contents</B
  36 ></DT
  37 ><DT
  38 >1. <A
  39 HREF="#Introduction"
  40 >Introduction</A
  41 ></DT
  42 ><DD
  43 ><DL
  44 ><DT
  45 >1.1. <A
  46 HREF="#Authentication"
  47 >Authentication</A
  48 ></DT
  49 ><DT
  50 >1.2. <A
  51 HREF="#Roles"
  52 >Roles</A
  53 ></DT
  54 ><DT
  55 >1.3. <A
  56 HREF="#Filters"
  57 >Filters</A
  58 ></DT
  59 ><DT
  60 >1.4. <A
  61 HREF="#AEN91"
  62 >PlanetLab shell</A
  63 ></DT
  64 ></DL
  65 ></DD
  66 ><DT
  67 >2. <A
  68 HREF="#Methods"
  69 >PlanetLab API Methods</A
  70 ></DT
  71 ><DD
  72 ><DL
  73 ><DT
  74 >2.1. <A
  75 HREF="#AddAddressType"
  76 >AddAddressType</A
  77 ></DT
  78 ><DT
  79 >2.2. <A
  80 HREF="#AddAddressTypeToAddress"
  81 >AddAddressTypeToAddress</A
  82 ></DT
  83 ><DT
  84 >2.3. <A
  85 HREF="#AddBootState"
  86 >AddBootState</A
  87 ></DT
  88 ><DT
  89 >2.4. <A
  90 HREF="#AddConfFile"
  91 >AddConfFile</A
  92 ></DT
  93 ><DT
  94 >2.5. <A
  95 HREF="#AddConfFileToNodeGroup"
  96 >AddConfFileToNodeGroup</A
  97 ></DT
  98 ><DT
  99 >2.6. <A
 100 HREF="#AddConfFileToNode"
 101 >AddConfFileToNode</A
 102 ></DT
 103 ><DT
 104 >2.7. <A
 105 HREF="#AddKeyType"
 106 >AddKeyType</A
 107 ></DT
 108 ><DT
 109 >2.8. <A
 110 HREF="#AddMessage"
 111 >AddMessage</A
 112 ></DT
 113 ><DT
 114 >2.9. <A
 115 HREF="#AddNetworkMethod"
 116 >AddNetworkMethod</A
 117 ></DT
 118 ><DT
 119 >2.10. <A
 120 HREF="#AddNetworkType"
 121 >AddNetworkType</A
 122 ></DT
 123 ><DT
 124 >2.11. <A
 125 HREF="#AddNodeGroup"
 126 >AddNodeGroup</A
 127 ></DT
 128 ><DT
 129 >2.12. <A
 130 HREF="#AddNodeNetwork"
 131 >AddNodeNetwork</A
 132 ></DT
 133 ><DT
 134 >2.13. <A
 135 HREF="#AddNode"
 136 >AddNode</A
 137 ></DT
 138 ><DT
 139 >2.14. <A
 140 HREF="#AddNodeToNodeGroup"
 141 >AddNodeToNodeGroup</A
 142 ></DT
 143 ><DT
 144 >2.15. <A
 145 HREF="#AddNodeToPCU"
 146 >AddNodeToPCU</A
 147 ></DT
 148 ><DT
 149 >2.16. <A
 150 HREF="#AddPCU"
 151 >AddPCU</A
 152 ></DT
 153 ><DT
 154 >2.17. <A
 155 HREF="#AddPeer"
 156 >AddPeer</A
 157 ></DT
 158 ><DT
 159 >2.18. <A
 160 HREF="#AddPersonKey"
 161 >AddPersonKey</A
 162 ></DT
 163 ><DT
 164 >2.19. <A
 165 HREF="#AddPerson"
 166 >AddPerson</A
 167 ></DT
 168 ><DT
 169 >2.20. <A
 170 HREF="#AddPersonToSite"
 171 >AddPersonToSite</A
 172 ></DT
 173 ><DT
 174 >2.21. <A
 175 HREF="#AddPersonToSlice"
 176 >AddPersonToSlice</A
 177 ></DT
 178 ><DT
 179 >2.22. <A
 180 HREF="#AddRole"
 181 >AddRole</A
 182 ></DT
 183 ><DT
 184 >2.23. <A
 185 HREF="#AddRoleToPerson"
 186 >AddRoleToPerson</A
 187 ></DT
 188 ><DT
 189 >2.24. <A
 190 HREF="#AddSiteAddress"
 191 >AddSiteAddress</A
 192 ></DT
 193 ><DT
 194 >2.25. <A
 195 HREF="#AddSite"
 196 >AddSite</A
 197 ></DT
 198 ><DT
 199 >2.26. <A
 200 HREF="#AddSliceAttribute"
 201 >AddSliceAttribute</A
 202 ></DT
 203 ><DT
 204 >2.27. <A
 205 HREF="#AddSliceAttributeType"
 206 >AddSliceAttributeType</A
 207 ></DT
 208 ><DT
 209 >2.28. <A
 210 HREF="#AddSliceInstantiation"
 211 >AddSliceInstantiation</A
 212 ></DT
 213 ><DT
 214 >2.29. <A
 215 HREF="#AddSlice"
 216 >AddSlice</A
 217 ></DT
 218 ><DT
 219 >2.30. <A
 220 HREF="#AddSliceToNodes"
 221 >AddSliceToNodes</A
 222 ></DT
 223 ><DT
 224 >2.31. <A
 225 HREF="#AuthCheck"
 226 >AuthCheck</A
 227 ></DT
 228 ><DT
 229 >2.32. <A
 230 HREF="#BlacklistKey"
 231 >BlacklistKey</A
 232 ></DT
 233 ><DT
 234 >2.33. <A
 235 HREF="#BootGetNodeDetails"
 236 >BootGetNodeDetails</A
 237 ></DT
 238 ><DT
 239 >2.34. <A
 240 HREF="#BootNotifyOwners"
 241 >BootNotifyOwners</A
 242 ></DT
 243 ><DT
 244 >2.35. <A
 245 HREF="#BootUpdateNode"
 246 >BootUpdateNode</A
 247 ></DT
 248 ><DT
 249 >2.36. <A
 250 HREF="#DeleteAddress"
 251 >DeleteAddress</A
 252 ></DT
 253 ><DT
 254 >2.37. <A
 255 HREF="#DeleteAddressTypeFromAddress"
 256 >DeleteAddressTypeFromAddress</A
 257 ></DT
 258 ><DT
 259 >2.38. <A
 260 HREF="#DeleteAddressType"
 261 >DeleteAddressType</A
 262 ></DT
 263 ><DT
 264 >2.39. <A
 265 HREF="#DeleteBootState"
 266 >DeleteBootState</A
 267 ></DT
 268 ><DT
 269 >2.40. <A
 270 HREF="#DeleteConfFileFromNodeGroup"
 271 >DeleteConfFileFromNodeGroup</A
 272 ></DT
 273 ><DT
 274 >2.41. <A
 275 HREF="#DeleteConfFileFromNode"
 276 >DeleteConfFileFromNode</A
 277 ></DT
 278 ><DT
 279 >2.42. <A
 280 HREF="#DeleteConfFile"
 281 >DeleteConfFile</A
 282 ></DT
 283 ><DT
 284 >2.43. <A
 285 HREF="#DeleteKey"
 286 >DeleteKey</A
 287 ></DT
 288 ><DT
 289 >2.44. <A
 290 HREF="#DeleteKeyType"
 291 >DeleteKeyType</A
 292 ></DT
 293 ><DT
 294 >2.45. <A
 295 HREF="#DeleteMessage"
 296 >DeleteMessage</A
 297 ></DT
 298 ><DT
 299 >2.46. <A
 300 HREF="#DeleteNetworkMethod"
 301 >DeleteNetworkMethod</A
 302 ></DT
 303 ><DT
 304 >2.47. <A
 305 HREF="#DeleteNetworkType"
 306 >DeleteNetworkType</A
 307 ></DT
 308 ><DT
 309 >2.48. <A
 310 HREF="#DeleteNodeFromNodeGroup"
 311 >DeleteNodeFromNodeGroup</A
 312 ></DT
 313 ><DT
 314 >2.49. <A
 315 HREF="#DeleteNodeFromPCU"
 316 >DeleteNodeFromPCU</A
 317 ></DT
 318 ><DT
 319 >2.50. <A
 320 HREF="#DeleteNodeGroup"
 321 >DeleteNodeGroup</A
 322 ></DT
 323 ><DT
 324 >2.51. <A
 325 HREF="#DeleteNodeNetwork"
 326 >DeleteNodeNetwork</A
 327 ></DT
 328 ><DT
 329 >2.52. <A
 330 HREF="#DeleteNode"
 331 >DeleteNode</A
 332 ></DT
 333 ><DT
 334 >2.53. <A
 335 HREF="#DeletePCU"
 336 >DeletePCU</A
 337 ></DT
 338 ><DT
 339 >2.54. <A
 340 HREF="#DeletePeer"
 341 >DeletePeer</A
 342 ></DT
 343 ><DT
 344 >2.55. <A
 345 HREF="#DeletePersonFromSite"
 346 >DeletePersonFromSite</A
 347 ></DT
 348 ><DT
 349 >2.56. <A
 350 HREF="#DeletePersonFromSlice"
 351 >DeletePersonFromSlice</A
 352 ></DT
 353 ><DT
 354 >2.57. <A
 355 HREF="#DeletePerson"
 356 >DeletePerson</A
 357 ></DT
 358 ><DT
 359 >2.58. <A
 360 HREF="#DeleteRoleFromPerson"
 361 >DeleteRoleFromPerson</A
 362 ></DT
 363 ><DT
 364 >2.59. <A
 365 HREF="#DeleteRole"
 366 >DeleteRole</A
 367 ></DT
 368 ><DT
 369 >2.60. <A
 370 HREF="#DeleteSession"
 371 >DeleteSession</A
 372 ></DT
 373 ><DT
 374 >2.61. <A
 375 HREF="#DeleteSite"
 376 >DeleteSite</A
 377 ></DT
 378 ><DT
 379 >2.62. <A
 380 HREF="#DeleteSliceAttribute"
 381 >DeleteSliceAttribute</A
 382 ></DT
 383 ><DT
 384 >2.63. <A
 385 HREF="#DeleteSliceAttributeType"
 386 >DeleteSliceAttributeType</A
 387 ></DT
 388 ><DT
 389 >2.64. <A
 390 HREF="#DeleteSliceFromNodes"
 391 >DeleteSliceFromNodes</A
 392 ></DT
 393 ><DT
 394 >2.65. <A
 395 HREF="#DeleteSliceInstantiation"
 396 >DeleteSliceInstantiation</A
 397 ></DT
 398 ><DT
 399 >2.66. <A
 400 HREF="#DeleteSlice"
 401 >DeleteSlice</A
 402 ></DT
 403 ><DT
 404 >2.67. <A
 405 HREF="#GetAddresses"
 406 >GetAddresses</A
 407 ></DT
 408 ><DT
 409 >2.68. <A
 410 HREF="#GetAddressTypes"
 411 >GetAddressTypes</A
 412 ></DT
 413 ><DT
 414 >2.69. <A
 415 HREF="#GetBootStates"
 416 >GetBootStates</A
 417 ></DT
 418 ><DT
 419 >2.70. <A
 420 HREF="#GetConfFiles"
 421 >GetConfFiles</A
 422 ></DT
 423 ><DT
 424 >2.71. <A
 425 HREF="#GetEvents"
 426 >GetEvents</A
 427 ></DT
 428 ><DT
 429 >2.72. <A
 430 HREF="#GetKeys"
 431 >GetKeys</A
 432 ></DT
 433 ><DT
 434 >2.73. <A
 435 HREF="#GetKeyTypes"
 436 >GetKeyTypes</A
 437 ></DT
 438 ><DT
 439 >2.74. <A
 440 HREF="#GetMessages"
 441 >GetMessages</A
 442 ></DT
 443 ><DT
 444 >2.75. <A
 445 HREF="#GetNetworkMethods"
 446 >GetNetworkMethods</A
 447 ></DT
 448 ><DT
 449 >2.76. <A
 450 HREF="#GetNetworkTypes"
 451 >GetNetworkTypes</A
 452 ></DT
 453 ><DT
 454 >2.77. <A
 455 HREF="#GetNodeGroups"
 456 >GetNodeGroups</A
 457 ></DT
 458 ><DT
 459 >2.78. <A
 460 HREF="#GetNodeNetworks"
 461 >GetNodeNetworks</A
 462 ></DT
 463 ><DT
 464 >2.79. <A
 465 HREF="#GetNodes"
 466 >GetNodes</A
 467 ></DT
 468 ><DT
 469 >2.80. <A
 470 HREF="#GetPCUs"
 471 >GetPCUs</A
 472 ></DT
 473 ><DT
 474 >2.81. <A
 475 HREF="#GetPeerData"
 476 >GetPeerData</A
 477 ></DT
 478 ><DT
 479 >2.82. <A
 480 HREF="#GetPeerName"
 481 >GetPeerName</A
 482 ></DT
 483 ><DT
 484 >2.83. <A
 485 HREF="#GetPeers"
 486 >GetPeers</A
 487 ></DT
 488 ><DT
 489 >2.84. <A
 490 HREF="#GetPersons"
 491 >GetPersons</A
 492 ></DT
 493 ><DT
 494 >2.85. <A
 495 HREF="#GetRoles"
 496 >GetRoles</A
 497 ></DT
 498 ><DT
 499 >2.86. <A
 500 HREF="#GetSession"
 501 >GetSession</A
 502 ></DT
 503 ><DT
 504 >2.87. <A
 505 HREF="#GetSites"
 506 >GetSites</A
 507 ></DT
 508 ><DT
 509 >2.88. <A
 510 HREF="#GetSliceAttributes"
 511 >GetSliceAttributes</A
 512 ></DT
 513 ><DT
 514 >2.89. <A
 515 HREF="#GetSliceAttributeTypes"
 516 >GetSliceAttributeTypes</A
 517 ></DT
 518 ><DT
 519 >2.90. <A
 520 HREF="#GetSliceInstantiations"
 521 >GetSliceInstantiations</A
 522 ></DT
 523 ><DT
 524 >2.91. <A
 525 HREF="#GetSlices"
 526 >GetSlices</A
 527 ></DT
 528 ><DT
 529 >2.92. <A
 530 HREF="#GetSliceTicket"
 531 >GetSliceTicket</A
 532 ></DT
 533 ><DT
 534 >2.93. <A
 535 HREF="#GetSlivers"
 536 >GetSlivers</A
 537 ></DT
 538 ><DT
 539 >2.94. <A
 540 HREF="#NotifyPersons"
 541 >NotifyPersons</A
 542 ></DT
 543 ><DT
 544 >2.95. <A
 545 HREF="#RebootNode"
 546 >RebootNode</A
 547 ></DT
 548 ><DT
 549 >2.96. <A
 550 HREF="#RefreshPeer"
 551 >RefreshPeer</A
 552 ></DT
 553 ><DT
 554 >2.97. <A
 555 HREF="#ResetPassword"
 556 >ResetPassword</A
 557 ></DT
 558 ><DT
 559 >2.98. <A
 560 HREF="#SetPersonPrimarySite"
 561 >SetPersonPrimarySite</A
 562 ></DT
 563 ><DT
 564 >2.99. <A
 565 HREF="#UpdateAddress"
 566 >UpdateAddress</A
 567 ></DT
 568 ><DT
 569 >2.100. <A
 570 HREF="#UpdateAddressType"
 571 >UpdateAddressType</A
 572 ></DT
 573 ><DT
 574 >2.101. <A
 575 HREF="#UpdateConfFile"
 576 >UpdateConfFile</A
 577 ></DT
 578 ><DT
 579 >2.102. <A
 580 HREF="#UpdateKey"
 581 >UpdateKey</A
 582 ></DT
 583 ><DT
 584 >2.103. <A
 585 HREF="#UpdateMessage"
 586 >UpdateMessage</A
 587 ></DT
 588 ><DT
 589 >2.104. <A
 590 HREF="#UpdateNodeGroup"
 591 >UpdateNodeGroup</A
 592 ></DT
 593 ><DT
 594 >2.105. <A
 595 HREF="#UpdateNodeNetwork"
 596 >UpdateNodeNetwork</A
 597 ></DT
 598 ><DT
 599 >2.106. <A
 600 HREF="#UpdateNode"
 601 >UpdateNode</A
 602 ></DT
 603 ><DT
 604 >2.107. <A
 605 HREF="#UpdatePCU"
 606 >UpdatePCU</A
 607 ></DT
 608 ><DT
 609 >2.108. <A
 610 HREF="#UpdatePeer"
 611 >UpdatePeer</A
 612 ></DT
 613 ><DT
 614 >2.109. <A
 615 HREF="#UpdatePerson"
 616 >UpdatePerson</A
 617 ></DT
 618 ><DT
 619 >2.110. <A
 620 HREF="#UpdateSite"
 621 >UpdateSite</A
 622 ></DT
 623 ><DT
 624 >2.111. <A
 625 HREF="#UpdateSliceAttribute"
 626 >UpdateSliceAttribute</A
 627 ></DT
 628 ><DT
 629 >2.112. <A
 630 HREF="#UpdateSliceAttributeType"
 631 >UpdateSliceAttributeType</A
 632 ></DT
 633 ><DT
 634 >2.113. <A
 635 HREF="#UpdateSlice"
 636 >UpdateSlice</A
 637 ></DT
 638 ><DT
 639 >2.114. <A
 640 HREF="#VerifyPerson"
 641 >VerifyPerson</A
 642 ></DT
 643 ><DT
 644 >2.115. <A
 645 HREF="#system.listMethods"
 646 >system.listMethods</A
 647 ></DT
 648 ><DT
 649 >2.116. <A
 650 HREF="#system.methodHelp"
 651 >system.methodHelp</A
 652 ></DT
 653 ><DT
 654 >2.117. <A
 655 HREF="#system.methodSignature"
 656 >system.methodSignature</A
 657 ></DT
 658 ><DT
 659 >2.118. <A
 660 HREF="#system.multicall"
 661 >system.multicall</A
 662 ></DT
 663 ></DL
 664 ></DD
 665 ></DL
 666 ></DIV
 667 ><DIV
 668 CLASS="chapter"
 669 ><HR><H1
 670 ><A
 671 NAME="Introduction"
 672 ></A
 673 >Chapter 1. Introduction</H1
 674 ><P
 675 >The PlanetLab Central API (PLCAPI) is the interface through
 676     which the PlanetLab Central database should be accessed and
 677     maintained. The API is used by the website, by nodes, by automated
 678     scripts, and by users to access and update information about
 679     users, nodes, sites, slices, and other entities maintained by the
 680     database.</P
 681 ><DIV
 682 CLASS="section"
 683 ><HR><H2
 684 CLASS="section"
 685 ><A
 686 NAME="Authentication"
 687 >1.1. Authentication</A
 688 ></H2
 689 ><P
 690 >The API should be accessed via XML-RPC over HTTPS. The API
 691       supports the standard introspection calls <A
 692 HREF="#system.listMethods"
 693 >system.listMethods</A
 694 >, <A
 695 HREF="#system.methodSignature"
 696 >system.methodSignature</A
 697 >,
 698       and <A
 699 HREF="#system.methodHelp"
 700 >system.methodHelp</A
 701 >,
 702       and the standard batching call <A
 703 HREF="#system.multicall"
 704 >system.multicall</A
 705 >. With the
 706       exception of these calls, all PLCAPI calls take an
 707       authentication structure as their first argument. All
 708       authentication structures require the specification of
 709       <CODE
 710 CLASS="parameter"
 711 >AuthMethod</CODE
 712 >. If the documentation for a
 713       call does not further specify the authentication structure, then
 714       any of (but only) the following authentication structures may be
 715       used:</P
 716 ><P
 717 ></P
 718 ><UL
 719 ><LI
 720 ><P
 721 >Session authentication. User sessions are typically
 722           valid for 24 hours. Node sessions are valid until the next
 723           reboot. Obtain a session key with <A
 724 HREF="#GetSession"
 725 >GetSession</A
 726 > using another form of
 727           authentication, such as password or GnuPG
 728           authentication.</P
 729 ><DIV
 730 CLASS="informaltable"
 731 ><P
 732 ></P
 733 ><A
 734 NAME="AEN19"
 735 ></A
 736 ><TABLE
 737 BORDER="0"
 738 FRAME="void"
 739 CLASS="CALSTABLE"
 740 ><COL><COL><COL><TBODY
 741 ><TR
 742 ><TD
 743 >AuthMethod</TD
 744 ><TD
 745 ><TT
 746 CLASS="literal"
 747 >session</TT
 748 ></TD
 749 ><TD
 750 >&nbsp;</TD
 751 ></TR
 752 ><TR
 753 ><TD
 754 >session</TD
 755 ><TD
 756 >Session key</TD
 757 ><TD
 758 >&nbsp;</TD
 759 ></TR
 760 ></TBODY
 761 ></TABLE
 762 ><P
 763 ></P
 764 ></DIV
 765 ></LI
 766 ><LI
 767 ><P
 768 >Password authentication.</P
 769 ><DIV
 770 CLASS="informaltable"
 771 ><P
 772 ></P
 773 ><A
 774 NAME="AEN31"
 775 ></A
 776 ><TABLE
 777 BORDER="0"
 778 FRAME="void"
 779 CLASS="CALSTABLE"
 780 ><COL><COL><COL><TBODY
 781 ><TR
 782 ><TD
 783 >AuthMethod</TD
 784 ><TD
 785 ><TT
 786 CLASS="literal"
 787 >password</TT
 788 ></TD
 789 ><TD
 790 >&nbsp;</TD
 791 ></TR
 792 ><TR
 793 ><TD
 794 >Username</TD
 795 ><TD
 796 >Username, typically an e-mail address</TD
 797 ><TD
 798 >&nbsp;</TD
 799 ></TR
 800 ><TR
 801 ><TD
 802 >AuthString</TD
 803 ><TD
 804 >Authentication string, typically a password</TD
 805 ><TD
 806 >&nbsp;</TD
 807 ></TR
 808 ></TBODY
 809 ></TABLE
 810 ><P
 811 ></P
 812 ></DIV
 813 ></LI
 814 ><LI
 815 ><P
 816 >GnuPG authentication. Users may upload a GPG public key
 817           using <A
 818 HREF="#AddPersonKey"
 819 >AddPersonKey</A
 820 >. Peer
 821           GPG keys should be added with <A
 822 HREF="#AddPeer"
 823 >AddPeer</A
 824 > or <A
 825 HREF="#UpdatePeer"
 826 >UpdatePeer</A
 827 >.
 828           </P
 829 ><DIV
 830 CLASS="informaltable"
 831 ><P
 832 ></P
 833 ><A
 834 NAME="AEN49"
 835 ></A
 836 ><TABLE
 837 BORDER="0"
 838 FRAME="void"
 839 CLASS="CALSTABLE"
 840 ><COL><COL><COL><TBODY
 841 ><TR
 842 ><TD
 843 >AuthMethod</TD
 844 ><TD
 845 ><TT
 846 CLASS="literal"
 847 >gpg</TT
 848 ></TD
 849 ><TD
 850 >&nbsp;</TD
 851 ></TR
 852 ><TR
 853 ><TD
 854 >name</TD
 855 ><TD
 856 >Peer or user name</TD
 857 ><TD
 858 >&nbsp;</TD
 859 ></TR
 860 ><TR
 861 ><TD
 862 >signature</TD
 863 ><TD
 864 >GnuPG signature of
 865                 the <A
 866 HREF="http://www.w3.org/TR/xml-c14n"
 867 TARGET="_top"
 868 >canonicalized</A
 869 >
 870                 <A
 871 HREF="http://www.xmlrpc.com/spec"
 872 TARGET="_top"
 873 >XML-RPC</A
 874 >
 875                 representation of the rest of the arguments to the
 876                 call.</TD
 877 ><TD
 878 >&nbsp;</TD
 879 ></TR
 880 ></TBODY
 881 ></TABLE
 882 ><P
 883 ></P
 884 ></DIV
 885 ></LI
 886 ><LI
 887 ><P
 888 >Anonymous authentication.</P
 889 ><DIV
 890 CLASS="informaltable"
 891 ><P
 892 ></P
 893 ><A
 894 NAME="AEN66"
 895 ></A
 896 ><TABLE
 897 BORDER="0"
 898 FRAME="void"
 899 CLASS="CALSTABLE"
 900 ><COL><COL><COL><TBODY
 901 ><TR
 902 ><TD
 903 >AuthMethod</TD
 904 ><TD
 905 ><TT
 906 CLASS="literal"
 907 >anonymous</TT
 908 ></TD
 909 ><TD
 910 >&nbsp;</TD
 911 ></TR
 912 ></TBODY
 913 ></TABLE
 914 ><P
 915 ></P
 916 ></DIV
 917 ></LI
 918 ></UL
 919 ></DIV
 920 ><DIV
 921 CLASS="section"
 922 ><HR><H2
 923 CLASS="section"
 924 ><A
 925 NAME="Roles"
 926 >1.2. Roles</A
 927 ></H2
 928 ><P
 929 >Some functions may only be called by users with certain
 930       roles (see <A
 931 HREF="#GetRoles"
 932 >GetRoles</A
 933 >), and others
 934       may return different information to different callers depending
 935       on the role(s) of the caller.</P
 936 ><P
 937 >The <TT
 938 CLASS="literal"
 939 >node</TT
 940 > and
 941       <TT
 942 CLASS="literal"
 943 >anonymous</TT
 944 > roles are pseudo-roles. A function
 945       that allows the <TT
 946 CLASS="literal"
 947 >node</TT
 948 > role may be called by
 949       automated scripts running on a node, such as the Boot and Node
 950       Managers. A function that allows the
 951       <TT
 952 CLASS="literal"
 953 >anonymous</TT
 954 > role may be called by anyone; an
 955       API authentication structure must still be specified (see <A
 956 HREF="#Authentication"
 957 >Section 1.1</A
 958 >).</P
 959 ></DIV
 960 ><DIV
 961 CLASS="section"
 962 ><HR><H2
 963 CLASS="section"
 964 ><A
 965 NAME="Filters"
 966 >1.3. Filters</A
 967 ></H2
 968 ><P
 969 >Most of the <CODE
 970 CLASS="function"
 971 >Get</CODE
 972 > functions take a
 973       filter argument. Filters may be arrays of integer (and sometimes
 974       string) identifiers, or a struct representing a filter on the
 975       attributes of the entities being queried. For example,</P
 976 ><PRE
 977 CLASS="programlisting"
 978 >&#13;# plcsh code fragment (see below)
 979 GetNodes([1,2,3])
 980 GetNodes({'node_id': [1,2,3]})
 981 GetNodes({'node_id': 1}) + GetNodes({'node_id': 2}) + GetNodes({'node_id': 3})
 982 </PRE
 983 ><P
 984 >Would all be equivalent queries. Attributes that are
 985       themselves arrays (such as <TT
 986 CLASS="literal"
 987 >nodenetwork_ids</TT
 988 >
 989       and <TT
 990 CLASS="literal"
 991 >slice_ids</TT
 992 > for nodes) cannot be used in
 993       filters.</P
 994 ></DIV
 995 ><DIV
 996 CLASS="section"
 997 ><HR><H2
 998 CLASS="section"
 999 ><A
1000 NAME="AEN91"
1001 >1.4. PlanetLab shell</A
1002 ></H2
1003 ><P
1004 >A command-line program called <B
1005 CLASS="command"
1006 >plcsh</B
1007 >
1008       simplifies authentication structure handling, and is useful for
1009       scripting. This program is distributed as a Linux RPM called
1010       PLCAPI and requires Python &#8805;2.4.</P
1011 ><PRE
1012 CLASS="programlisting"
1013 >&#13;usage: plcsh [options]
1014
1015 options:
1016   -f CONFIG, --config=CONFIG
1017                         PLC configuration file
1018   -h URL, --url=URL     API URL
1019   -c CACERT, --cacert=CACERT
1020                         API SSL certificate
1021   -k INSECURE, --insecure=INSECURE
1022                         Do not check SSL certificate
1023   -m METHOD, --method=METHOD
1024                         API authentication method
1025   -s SESSION, --session=SESSION
1026                         API session key
1027   -u USER, --user=USER  API user name
1028   -p PASSWORD, --password=PASSWORD
1029                         API password
1030   -r ROLE, --role=ROLE  API role
1031   -x, --xmlrpc          Use XML-RPC interface
1032   --help                show this help message and exit
1033       </PRE
1034 ><P
1035 >Specify at least the API URL and your user name:</P
1036 ><PRE
1037 CLASS="programlisting"
1038 >&#13;plcsh --url https://www.planet-lab.org/PLCAPI/ -u user@site.edu
1039       </PRE
1040 ><P
1041 >You will be presented with a prompt. From here, you can
1042       invoke API calls and omit the authentication structure, as it will
1043       be filled in automatically.</P
1044 ><PRE
1045 CLASS="programlisting"
1046 >&#13;user@site.edu connected using password authentication
1047 Type "system.listMethods()" or "help(method)" for more information.
1048 [user@site.edu]&#62;&#62;&#62; AuthCheck()
1049 1
1050 [user@site.edu]&#62;&#62;&#62; GetNodes([121], ['node_id', 'hostname'])
1051 [{'node_id': 121, 'hostname': 'planetlab-1.cs.princeton.edu'}]
1052       </PRE
1053 ><P
1054 >As this program is actually a Python interpreter, you may
1055       create variables, execute for loops, import other packages, etc.,
1056       directly on the command line as you would using the regular Python
1057       shell.</P
1058 ><P
1059 >To use <B
1060 CLASS="command"
1061 >plcsh</B
1062 > programmatically, import
1063       the <CODE
1064 CLASS="function"
1065 >PLC.Shell</CODE
1066 > module:</P
1067 ><PRE
1068 CLASS="programlisting"
1069 >&#13;#!/usr/bin/python
1070
1071 import sys
1072
1073 # Default location that the PLCAPI RPM installs the PLC class
1074 sys.path.append('/usr/share/plc_api')
1075
1076 # Initialize shell environment. Shell() will define all PLCAPI methods
1077 # in the specified namespace (specifying globals() will define them
1078 # globally).
1079 from PLC.Shell import Shell
1080 plc = Shell(globals(),
1081             url = "https://www.planet-lab.org/PLCAPI/",
1082             user = "user@site.edu",
1083             password = "password")
1084
1085 # Both are equivalent
1086 nodes = GetNodes([121], ['node_id', 'hostname'])
1087 nodes = plc.GetNodes([121], ['node_id', 'hostname'])
1088       </PRE
1089 ></DIV
1090 ></DIV
1091 ><DIV
1092 CLASS="chapter"
1093 ><HR><H1
1094 ><A
1095 NAME="Methods"
1096 ></A
1097 >Chapter 2. PlanetLab API Methods</H1
1098 ><P
1099 ></P
1100 ><DIV
1101 CLASS="section"
1102 ><HR><H2
1103 CLASS="section"
1104 ><A
1105 NAME="AddAddressType"
1106 >2.1. AddAddressType</A
1107 ></H2
1108 ><P
1109 >Prototype:<A
1110 NAME="AEN111"
1111 ></A
1112 ><BLOCKQUOTE
1113 CLASS="BLOCKQUOTE"
1114 ><P
1115 >AddAddressType (auth, address_type_fields)</P
1116 ></BLOCKQUOTE
1117 ></P
1118 ><P
1119 >Description:<A
1120 NAME="AEN114"
1121 ></A
1122 ><BLOCKQUOTE
1123 CLASS="BLOCKQUOTE"
1124 ><P
1125 >Adds a new address type. Fields specified in address_type_fields
1126 are used.</P
1127 ><P
1128 >Returns the new address_type_id (&#62; 0) if successful, faults otherwise.</P
1129 ></BLOCKQUOTE
1130 ></P
1131 ><P
1132 >Allowed Roles:<A
1133 NAME="AEN118"
1134 ></A
1135 ><BLOCKQUOTE
1136 CLASS="BLOCKQUOTE"
1137 ><P
1138 >admin</P
1139 ></BLOCKQUOTE
1140 ></P
1141 ><P
1142 >Parameters:</P
1143 ><P
1144 ></P
1145 ><UL
1146 ><LI
1147 ><P
1148 >&#13;                          <CODE
1149 CLASS="parameter"
1150 >auth</CODE
1151 >
1152 : struct, API authentication structure                  </P
1153 ><P
1154 ></P
1155 ><UL
1156 ><LI
1157 ><P
1158 >&#13;                                          <CODE
1159 CLASS="parameter"
1160 >AuthMethod</CODE
1161 >
1162 : string, Authentication method to use                                  </P
1163 ></LI
1164 ></UL
1165 ></LI
1166 ><LI
1167 ><P
1168 >&#13;                          <CODE
1169 CLASS="parameter"
1170 >address_type_fields</CODE
1171 >
1172 : struct                        </P
1173 ><P
1174 ></P
1175 ><UL
1176 ><LI
1177 ><P
1178 >&#13;                                          <CODE
1179 CLASS="parameter"
1180 >name</CODE
1181 >
1182 : string, Address type                                  </P
1183 ></LI
1184 ><LI
1185 ><P
1186 >&#13;                                          <CODE
1187 CLASS="parameter"
1188 >description</CODE
1189 >
1190 : string, Address type description                                      </P
1191 ></LI
1192 ></UL
1193 ></LI
1194 ></UL
1195 ><P
1196 >Returns:</P
1197 ><P
1198 ></P
1199 ><UL
1200 ><LI
1201 ><P
1202 >&#13;int, New address_type_id (&#62; 0) if successful                  </P
1203 ></LI
1204 ></UL
1205 ></DIV
1206 ><DIV
1207 CLASS="section"
1208 ><HR><H2
1209 CLASS="section"
1210 ><A
1211 NAME="AddAddressTypeToAddress"
1212 >2.2. AddAddressTypeToAddress</A
1213 ></H2
1214 ><P
1215 >Prototype:<A
1216 NAME="AEN146"
1217 ></A
1218 ><BLOCKQUOTE
1219 CLASS="BLOCKQUOTE"
1220 ><P
1221 >AddAddressTypeToAddress (auth, address_type_id_or_name, address_id)</P
1222 ></BLOCKQUOTE
1223 ></P
1224 ><P
1225 >Description:<A
1226 NAME="AEN149"
1227 ></A
1228 ><BLOCKQUOTE
1229 CLASS="BLOCKQUOTE"
1230 ><P
1231 >Adds an address type to the specified address.</P
1232 ><P
1233 >PIs may only update addresses of their own sites.</P
1234 ><P
1235 >Returns 1 if successful, faults otherwise.</P
1236 ></BLOCKQUOTE
1237 ></P
1238 ><P
1239 >Allowed Roles:<A
1240 NAME="AEN154"
1241 ></A
1242 ><BLOCKQUOTE
1243 CLASS="BLOCKQUOTE"
1244 ><P
1245 >admin, pi</P
1246 ></BLOCKQUOTE
1247 ></P
1248 ><P
1249 >Parameters:</P
1250 ><P
1251 ></P
1252 ><UL
1253 ><LI
1254 ><P
1255 >&#13;                          <CODE
1256 CLASS="parameter"
1257 >auth</CODE
1258 >
1259 : struct, API authentication structure                  </P
1260 ><P
1261 ></P
1262 ><UL
1263 ><LI
1264 ><P
1265 >&#13;                                          <CODE
1266 CLASS="parameter"
1267 >AuthMethod</CODE
1268 >
1269 : string, Authentication method to use                                  </P
1270 ></LI
1271 ></UL
1272 ></LI
1273 ><LI
1274 ><P
1275 >&#13;                          <CODE
1276 CLASS="parameter"
1277 >address_type_id_or_name</CODE
1278 >
1279 : int or string                 </P
1280 ><P
1281 ></P
1282 ><UL
1283 ><LI
1284 ><P
1285 >&#13;int, Address type identifier                                      </P
1286 ></LI
1287 ><LI
1288 ><P
1289 >&#13;string, Address type                                      </P
1290 ></LI
1291 ></UL
1292 ></LI
1293 ><LI
1294 ><P
1295 >&#13;                          <CODE
1296 CLASS="parameter"
1297 >address_id</CODE
1298 >
1299 : int, Address identifier                       </P
1300 ></LI
1301 ></UL
1302 ><P
1303 >Returns:</P
1304 ><P
1305 ></P
1306 ><UL
1307 ><LI
1308 ><P
1309 >&#13;int, 1 if successful                      </P
1310 ></LI
1311 ></UL
1312 ></DIV
1313 ><DIV
1314 CLASS="section"
1315 ><HR><H2
1316 CLASS="section"
1317 ><A
1318 NAME="AddBootState"
1319 >2.3. AddBootState</A
1320 ></H2
1321 ><P
1322 >Prototype:<A
1323 NAME="AEN183"
1324 ></A
1325 ><BLOCKQUOTE
1326 CLASS="BLOCKQUOTE"
1327 ><P
1328 >AddBootState (auth, name)</P
1329 ></BLOCKQUOTE
1330 ></P
1331 ><P
1332 >Description:<A
1333 NAME="AEN186"
1334 ></A
1335 ><BLOCKQUOTE
1336 CLASS="BLOCKQUOTE"
1337 ><P
1338 >Adds a new node boot state.</P
1339 ><P
1340 >Returns 1 if successful, faults otherwise.</P
1341 ></BLOCKQUOTE
1342 ></P
1343 ><P
1344 >Allowed Roles:<A
1345 NAME="AEN190"
1346 ></A
1347 ><BLOCKQUOTE
1348 CLASS="BLOCKQUOTE"
1349 ><P
1350 >admin</P
1351 ></BLOCKQUOTE
1352 ></P
1353 ><P
1354 >Parameters:</P
1355 ><P
1356 ></P
1357 ><UL
1358 ><LI
1359 ><P
1360 >&#13;                          <CODE
1361 CLASS="parameter"
1362 >auth</CODE
1363 >
1364 : struct, API authentication structure                  </P
1365 ><P
1366 ></P
1367 ><UL
1368 ><LI
1369 ><P
1370 >&#13;                                          <CODE
1371 CLASS="parameter"
1372 >AuthMethod</CODE
1373 >
1374 : string, Authentication method to use                                  </P
1375 ></LI
1376 ></UL
1377 ></LI
1378 ><LI
1379 ><P
1380 >&#13;                          <CODE
1381 CLASS="parameter"
1382 >name</CODE
1383 >
1384 : string, Boot state                    </P
1385 ></LI
1386 ></UL
1387 ><P
1388 >Returns:</P
1389 ><P
1390 ></P
1391 ><UL
1392 ><LI
1393 ><P
1394 >&#13;int, 1 if successful                      </P
1395 ></LI
1396 ></UL
1397 ></DIV
1398 ><DIV
1399 CLASS="section"
1400 ><HR><H2
1401 CLASS="section"
1402 ><A
1403 NAME="AddConfFile"
1404 >2.4. AddConfFile</A
1405 ></H2
1406 ><P
1407 >Prototype:<A
1408 NAME="AEN211"
1409 ></A
1410 ><BLOCKQUOTE
1411 CLASS="BLOCKQUOTE"
1412 ><P
1413 >AddConfFile (auth, conf_file_fields)</P
1414 ></BLOCKQUOTE
1415 ></P
1416 ><P
1417 >Description:<A
1418 NAME="AEN214"
1419 ></A
1420 ><BLOCKQUOTE
1421 CLASS="BLOCKQUOTE"
1422 ><P
1423 >Adds a new node configuration file. Any fields specified in
1424 conf_file_fields are used, otherwise defaults are used.</P
1425 ><P
1426 >Returns the new conf_file_id (&#62; 0) if successful, faults otherwise.</P
1427 ></BLOCKQUOTE
1428 ></P
1429 ><P
1430 >Allowed Roles:<A
1431 NAME="AEN218"
1432 ></A
1433 ><BLOCKQUOTE
1434 CLASS="BLOCKQUOTE"
1435 ><P
1436 >admin</P
1437 ></BLOCKQUOTE
1438 ></P
1439 ><P
1440 >Parameters:</P
1441 ><P
1442 ></P
1443 ><UL
1444 ><LI
1445 ><P
1446 >&#13;                          <CODE
1447 CLASS="parameter"
1448 >auth</CODE
1449 >
1450 : struct, API authentication structure                  </P
1451 ><P
1452 ></P
1453 ><UL
1454 ><LI
1455 ><P
1456 >&#13;                                          <CODE
1457 CLASS="parameter"
1458 >AuthMethod</CODE
1459 >
1460 : string, Authentication method to use                                  </P
1461 ></LI
1462 ></UL
1463 ></LI
1464 ><LI
1465 ><P
1466 >&#13;                          <CODE
1467 CLASS="parameter"
1468 >conf_file_fields</CODE
1469 >
1470 : struct                        </P
1471 ><P
1472 ></P
1473 ><UL
1474 ><LI
1475 ><P
1476 >&#13;                                          <CODE
1477 CLASS="parameter"
1478 >file_owner</CODE
1479 >
1480 : string, chown(1) owner                                        </P
1481 ></LI
1482 ><LI
1483 ><P
1484 >&#13;                                          <CODE
1485 CLASS="parameter"
1486 >postinstall_cmd</CODE
1487 >
1488 : string, Shell command to execute after installing                                     </P
1489 ></LI
1490 ><LI
1491 ><P
1492 >&#13;                                          <CODE
1493 CLASS="parameter"
1494 >error_cmd</CODE
1495 >
1496 : string, Shell command to execute if any error occurs                                  </P
1497 ></LI
1498 ><LI
1499 ><P
1500 >&#13;                                          <CODE
1501 CLASS="parameter"
1502 >preinstall_cmd</CODE
1503 >
1504 : string, Shell command to execute prior to installing                                  </P
1505 ></LI
1506 ><LI
1507 ><P
1508 >&#13;                                          <CODE
1509 CLASS="parameter"
1510 >dest</CODE
1511 >
1512 : string, Absolute path where file should be installed                                  </P
1513 ></LI
1514 ><LI
1515 ><P
1516 >&#13;                                          <CODE
1517 CLASS="parameter"
1518 >ignore_cmd_errors</CODE
1519 >
1520 : boolean, Install file anyway even if an error occurs                                  </P
1521 ></LI
1522 ><LI
1523 ><P
1524 >&#13;                                          <CODE
1525 CLASS="parameter"
1526 >enabled</CODE
1527 >
1528 : boolean, Configuration file is active                                 </P
1529 ></LI
1530 ><LI
1531 ><P
1532 >&#13;                                          <CODE
1533 CLASS="parameter"
1534 >file_permissions</CODE
1535 >
1536 : string, chmod(1) permissions                                  </P
1537 ></LI
1538 ><LI
1539 ><P
1540 >&#13;                                          <CODE
1541 CLASS="parameter"
1542 >source</CODE
1543 >
1544 : string, Relative path on the boot server where file can be downloaded                                 </P
1545 ></LI
1546 ><LI
1547 ><P
1548 >&#13;                                          <CODE
1549 CLASS="parameter"
1550 >always_update</CODE
1551 >
1552 : boolean, Always attempt to install file even if unchanged                                     </P
1553 ></LI
1554 ><LI
1555 ><P
1556 >&#13;                                          <CODE
1557 CLASS="parameter"
1558 >file_group</CODE
1559 >
1560 : string, chgrp(1) owner                                        </P
1561 ></LI
1562 ></UL
1563 ></LI
1564 ></UL
1565 ><P
1566 >Returns:</P
1567 ><P
1568 ></P
1569 ><UL
1570 ><LI
1571 ><P
1572 >&#13;int, New conf_file_id (&#62; 0) if successful                     </P
1573 ></LI
1574 ></UL
1575 ></DIV
1576 ><DIV
1577 CLASS="section"
1578 ><HR><H2
1579 CLASS="section"
1580 ><A
1581 NAME="AddConfFileToNodeGroup"
1582 >2.5. AddConfFileToNodeGroup</A
1583 ></H2
1584 ><P
1585 >Prototype:<A
1586 NAME="AEN273"
1587 ></A
1588 ><BLOCKQUOTE
1589 CLASS="BLOCKQUOTE"
1590 ><P
1591 >AddConfFileToNodeGroup (auth, conf_file_id, nodegroup_id_or_name)</P
1592 ></BLOCKQUOTE
1593 ></P
1594 ><P
1595 >Description:<A
1596 NAME="AEN276"
1597 ></A
1598 ><BLOCKQUOTE
1599 CLASS="BLOCKQUOTE"
1600 ><P
1601 >Adds a configuration file to the specified node group. If the node
1602 group is already linked to the configuration file, no errors are
1603 returned.</P
1604 ><P
1605 >Returns 1 if successful, faults otherwise.</P
1606 ></BLOCKQUOTE
1607 ></P
1608 ><P
1609 >Allowed Roles:<A
1610 NAME="AEN280"
1611 ></A
1612 ><BLOCKQUOTE
1613 CLASS="BLOCKQUOTE"
1614 ><P
1615 >admin</P
1616 ></BLOCKQUOTE
1617 ></P
1618 ><P
1619 >Parameters:</P
1620 ><P
1621 ></P
1622 ><UL
1623 ><LI
1624 ><P
1625 >&#13;                          <CODE
1626 CLASS="parameter"
1627 >auth</CODE
1628 >
1629 : struct, API authentication structure                  </P
1630 ><P
1631 ></P
1632 ><UL
1633 ><LI
1634 ><P
1635 >&#13;                                          <CODE
1636 CLASS="parameter"
1637 >AuthMethod</CODE
1638 >
1639 : string, Authentication method to use                                  </P
1640 ></LI
1641 ></UL
1642 ></LI
1643 ><LI
1644 ><P
1645 >&#13;                          <CODE
1646 CLASS="parameter"
1647 >conf_file_id</CODE
1648 >
1649 : int, Configuration file identifier                    </P
1650 ></LI
1651 ><LI
1652 ><P
1653 >&#13;                          <CODE
1654 CLASS="parameter"
1655 >nodegroup_id_or_name</CODE
1656 >
1657 : int or string                 </P
1658 ><P
1659 ></P
1660 ><UL
1661 ><LI
1662 ><P
1663 >&#13;int, Node group identifier                                        </P
1664 ></LI
1665 ><LI
1666 ><P
1667 >&#13;string, Node group name                                   </P
1668 ></LI
1669 ></UL
1670 ></LI
1671 ></UL
1672 ><P
1673 >Returns:</P
1674 ><P
1675 ></P
1676 ><UL
1677 ><LI
1678 ><P
1679 >&#13;int, 1 if successful                      </P
1680 ></LI
1681 ></UL
1682 ></DIV
1683 ><DIV
1684 CLASS="section"
1685 ><HR><H2
1686 CLASS="section"
1687 ><A
1688 NAME="AddConfFileToNode"
1689 >2.6. AddConfFileToNode</A
1690 ></H2
1691 ><P
1692 >Prototype:<A
1693 NAME="AEN309"
1694 ></A
1695 ><BLOCKQUOTE
1696 CLASS="BLOCKQUOTE"
1697 ><P
1698 >AddConfFileToNode (auth, conf_file_id, node_id_or_hostname)</P
1699 ></BLOCKQUOTE
1700 ></P
1701 ><P
1702 >Description:<A
1703 NAME="AEN312"
1704 ></A
1705 ><BLOCKQUOTE
1706 CLASS="BLOCKQUOTE"
1707 ><P
1708 >Adds a configuration file to the specified node. If the node is
1709 already linked to the configuration file, no errors are returned.</P
1710 ><P
1711 >Returns 1 if successful, faults otherwise.</P
1712 ></BLOCKQUOTE
1713 ></P
1714 ><P
1715 >Allowed Roles:<A
1716 NAME="AEN316"
1717 ></A
1718 ><BLOCKQUOTE
1719 CLASS="BLOCKQUOTE"
1720 ><P
1721 >admin</P
1722 ></BLOCKQUOTE
1723 ></P
1724 ><P
1725 >Parameters:</P
1726 ><P
1727 ></P
1728 ><UL
1729 ><LI
1730 ><P
1731 >&#13;                          <CODE
1732 CLASS="parameter"
1733 >auth</CODE
1734 >
1735 : struct, API authentication structure                  </P
1736 ><P
1737 ></P
1738 ><UL
1739 ><LI
1740 ><P
1741 >&#13;                                          <CODE
1742 CLASS="parameter"
1743 >AuthMethod</CODE
1744 >
1745 : string, Authentication method to use                                  </P
1746 ></LI
1747 ></UL
1748 ></LI
1749 ><LI
1750 ><P
1751 >&#13;                          <CODE
1752 CLASS="parameter"
1753 >conf_file_id</CODE
1754 >
1755 : int, Configuration file identifier                    </P
1756 ></LI
1757 ><LI
1758 ><P
1759 >&#13;                          <CODE
1760 CLASS="parameter"
1761 >node_id_or_hostname</CODE
1762 >
1763 : int or string                 </P
1764 ><P
1765 ></P
1766 ><UL
1767 ><LI
1768 ><P
1769 >&#13;int, Node identifier                                      </P
1770 ></LI
1771 ><LI
1772 ><P
1773 >&#13;string, Fully qualified hostname                                  </P
1774 ></LI
1775 ></UL
1776 ></LI
1777 ></UL
1778 ><P
1779 >Returns:</P
1780 ><P
1781 ></P
1782 ><UL
1783 ><LI
1784 ><P
1785 >&#13;int, 1 if successful                      </P
1786 ></LI
1787 ></UL
1788 ></DIV
1789 ><DIV
1790 CLASS="section"
1791 ><HR><H2
1792 CLASS="section"
1793 ><A
1794 NAME="AddKeyType"
1795 >2.7. AddKeyType</A
1796 ></H2
1797 ><P
1798 >Prototype:<A
1799 NAME="AEN345"
1800 ></A
1801 ><BLOCKQUOTE
1802 CLASS="BLOCKQUOTE"
1803 ><P
1804 >AddKeyType (auth, name)</P
1805 ></BLOCKQUOTE
1806 ></P
1807 ><P
1808 >Description:<A
1809 NAME="AEN348"
1810 ></A
1811 ><BLOCKQUOTE
1812 CLASS="BLOCKQUOTE"
1813 ><P
1814 >Adds a new key type.</P
1815 ><P
1816 >Returns 1 if successful, faults otherwise.</P
1817 ></BLOCKQUOTE
1818 ></P
1819 ><P
1820 >Allowed Roles:<A
1821 NAME="AEN352"
1822 ></A
1823 ><BLOCKQUOTE
1824 CLASS="BLOCKQUOTE"
1825 ><P
1826 >admin</P
1827 ></BLOCKQUOTE
1828 ></P
1829 ><P
1830 >Parameters:</P
1831 ><P
1832 ></P
1833 ><UL
1834 ><LI
1835 ><P
1836 >&#13;                          <CODE
1837 CLASS="parameter"
1838 >auth</CODE
1839 >
1840 : struct, API authentication structure                  </P
1841 ><P
1842 ></P
1843 ><UL
1844 ><LI
1845 ><P
1846 >&#13;                                          <CODE
1847 CLASS="parameter"
1848 >AuthMethod</CODE
1849 >
1850 : string, Authentication method to use                                  </P
1851 ></LI
1852 ></UL
1853 ></LI
1854 ><LI
1855 ><P
1856 >&#13;                          <CODE
1857 CLASS="parameter"
1858 >name</CODE
1859 >
1860 : string, Key type                      </P
1861 ></LI
1862 ></UL
1863 ><P
1864 >Returns:</P
1865 ><P
1866 ></P
1867 ><UL
1868 ><LI
1869 ><P
1870 >&#13;int, 1 if successful                      </P
1871 ></LI
1872 ></UL
1873 ></DIV
1874 ><DIV
1875 CLASS="section"
1876 ><HR><H2
1877 CLASS="section"
1878 ><A
1879 NAME="AddMessage"
1880 >2.8. AddMessage</A
1881 ></H2
1882 ><P
1883 >Prototype:<A
1884 NAME="AEN373"
1885 ></A
1886 ><BLOCKQUOTE
1887 CLASS="BLOCKQUOTE"
1888 ><P
1889 >AddMessage (auth, message_fields)</P
1890 ></BLOCKQUOTE
1891 ></P
1892 ><P
1893 >Description:<A
1894 NAME="AEN376"
1895 ></A
1896 ><BLOCKQUOTE
1897 CLASS="BLOCKQUOTE"
1898 ><P
1899 >Adds a new message template. Any values specified in
1900 message_fields are used, otherwise defaults are used.</P
1901 ><P
1902 >Returns 1 if successful, faults otherwise.</P
1903 ></BLOCKQUOTE
1904 ></P
1905 ><P
1906 >Allowed Roles:<A
1907 NAME="AEN380"
1908 ></A
1909 ><BLOCKQUOTE
1910 CLASS="BLOCKQUOTE"
1911 ><P
1912 >admin</P
1913 ></BLOCKQUOTE
1914 ></P
1915 ><P
1916 >Parameters:</P
1917 ><P
1918 ></P
1919 ><UL
1920 ><LI
1921 ><P
1922 >&#13;                          <CODE
1923 CLASS="parameter"
1924 >auth</CODE
1925 >
1926 : struct, API authentication structure                  </P
1927 ><P
1928 ></P
1929 ><UL
1930 ><LI
1931 ><P
1932 >&#13;                                          <CODE
1933 CLASS="parameter"
1934 >AuthMethod</CODE
1935 >
1936 : string, Authentication method to use                                  </P
1937 ></LI
1938 ></UL
1939 ></LI
1940 ><LI
1941 ><P
1942 >&#13;                          <CODE
1943 CLASS="parameter"
1944 >message_fields</CODE
1945 >
1946 : struct                        </P
1947 ><P
1948 ></P
1949 ><UL
1950 ><LI
1951 ><P
1952 >&#13;                                          <CODE
1953 CLASS="parameter"
1954 >enabled</CODE
1955 >
1956 : boolean, Message is enabled                                   </P
1957 ></LI
1958 ><LI
1959 ><P
1960 >&#13;                                          <CODE
1961 CLASS="parameter"
1962 >message_id</CODE
1963 >
1964 : string, Message identifier                                    </P
1965 ></LI
1966 ><LI
1967 ><P
1968 >&#13;                                          <CODE
1969 CLASS="parameter"
1970 >template</CODE
1971 >
1972 : string, Message template                                      </P
1973 ></LI
1974 ><LI
1975 ><P
1976 >&#13;                                          <CODE
1977 CLASS="parameter"
1978 >subject</CODE
1979 >
1980 : string, Message summary                                       </P
1981 ></LI
1982 ></UL
1983 ></LI
1984 ></UL
1985 ><P
1986 >Returns:</P
1987 ><P
1988 ></P
1989 ><UL
1990 ><LI
1991 ><P
1992 >&#13;int, 1 if successful                      </P
1993 ></LI
1994 ></UL
1995 ></DIV
1996 ><DIV
1997 CLASS="section"
1998 ><HR><H2
1999 CLASS="section"
2000 ><A
2001 NAME="AddNetworkMethod"
2002 >2.9. AddNetworkMethod</A
2003 ></H2
2004 ><P
2005 >Prototype:<A
2006 NAME="AEN414"
2007 ></A
2008 ><BLOCKQUOTE
2009 CLASS="BLOCKQUOTE"
2010 ><P
2011 >AddNetworkMethod (auth, name)</P
2012 ></BLOCKQUOTE
2013 ></P
2014 ><P
2015 >Description:<A
2016 NAME="AEN417"
2017 ></A
2018 ><BLOCKQUOTE
2019 CLASS="BLOCKQUOTE"
2020 ><P
2021 >Adds a new network method.</P
2022 ><P
2023 >Returns 1 if successful, faults otherwise.</P
2024 ></BLOCKQUOTE
2025 ></P
2026 ><P
2027 >Allowed Roles:<A
2028 NAME="AEN421"
2029 ></A
2030 ><BLOCKQUOTE
2031 CLASS="BLOCKQUOTE"
2032 ><P
2033 >admin</P
2034 ></BLOCKQUOTE
2035 ></P
2036 ><P
2037 >Parameters:</P
2038 ><P
2039 ></P
2040 ><UL
2041 ><LI
2042 ><P
2043 >&#13;                          <CODE
2044 CLASS="parameter"
2045 >auth</CODE
2046 >
2047 : struct, API authentication structure                  </P
2048 ><P
2049 ></P
2050 ><UL
2051 ><LI
2052 ><P
2053 >&#13;                                          <CODE
2054 CLASS="parameter"
2055 >AuthMethod</CODE
2056 >
2057 : string, Authentication method to use                                  </P
2058 ></LI
2059 ></UL
2060 ></LI
2061 ><LI
2062 ><P
2063 >&#13;                          <CODE
2064 CLASS="parameter"
2065 >name</CODE
2066 >
2067 : string, Network method                        </P
2068 ></LI
2069 ></UL
2070 ><P
2071 >Returns:</P
2072 ><P
2073 ></P
2074 ><UL
2075 ><LI
2076 ><P
2077 >&#13;int, 1 if successful                      </P
2078 ></LI
2079 ></UL
2080 ></DIV
2081 ><DIV
2082 CLASS="section"
2083 ><HR><H2
2084 CLASS="section"
2085 ><A
2086 NAME="AddNetworkType"
2087 >2.10. AddNetworkType</A
2088 ></H2
2089 ><P
2090 >Prototype:<A
2091 NAME="AEN442"
2092 ></A
2093 ><BLOCKQUOTE
2094 CLASS="BLOCKQUOTE"
2095 ><P
2096 >AddNetworkType (auth, name)</P
2097 ></BLOCKQUOTE
2098 ></P
2099 ><P
2100 >Description:<A
2101 NAME="AEN445"
2102 ></A
2103 ><BLOCKQUOTE
2104 CLASS="BLOCKQUOTE"
2105 ><P
2106 >Adds a new network type.</P
2107 ><P
2108 >Returns 1 if successful, faults otherwise.</P
2109 ></BLOCKQUOTE
2110 ></P
2111 ><P
2112 >Allowed Roles:<A
2113 NAME="AEN449"
2114 ></A
2115 ><BLOCKQUOTE
2116 CLASS="BLOCKQUOTE"
2117 ><P
2118 >admin</P
2119 ></BLOCKQUOTE
2120 ></P
2121 ><P
2122 >Parameters:</P
2123 ><P
2124 ></P
2125 ><UL
2126 ><LI
2127 ><P
2128 >&#13;                          <CODE
2129 CLASS="parameter"
2130 >auth</CODE
2131 >
2132 : struct, API authentication structure                  </P
2133 ><P
2134 ></P
2135 ><UL
2136 ><LI
2137 ><P
2138 >&#13;                                          <CODE
2139 CLASS="parameter"
2140 >AuthMethod</CODE
2141 >
2142 : string, Authentication method to use                                  </P
2143 ></LI
2144 ></UL
2145 ></LI
2146 ><LI
2147 ><P
2148 >&#13;                          <CODE
2149 CLASS="parameter"
2150 >name</CODE
2151 >
2152 : string, Network type                  </P
2153 ></LI
2154 ></UL
2155 ><P
2156 >Returns:</P
2157 ><P
2158 ></P
2159 ><UL
2160 ><LI
2161 ><P
2162 >&#13;int, 1 if successful                      </P
2163 ></LI
2164 ></UL
2165 ></DIV
2166 ><DIV
2167 CLASS="section"
2168 ><HR><H2
2169 CLASS="section"
2170 ><A
2171 NAME="AddNodeGroup"
2172 >2.11. AddNodeGroup</A
2173 ></H2
2174 ><P
2175 >Prototype:<A
2176 NAME="AEN470"
2177 ></A
2178 ><BLOCKQUOTE
2179 CLASS="BLOCKQUOTE"
2180 ><P
2181 >AddNodeGroup (auth, nodegroup_fields)</P
2182 ></BLOCKQUOTE
2183 ></P
2184 ><P
2185 >Description:<A
2186 NAME="AEN473"
2187 ></A
2188 ><BLOCKQUOTE
2189 CLASS="BLOCKQUOTE"
2190 ><P
2191 >Adds a new node group. Any values specified in nodegroup_fields
2192 are used, otherwise defaults are used.</P
2193 ><P
2194 >Returns the new nodegroup_id (&#62; 0) if successful, faults otherwise.</P
2195 ></BLOCKQUOTE
2196 ></P
2197 ><P
2198 >Allowed Roles:<A
2199 NAME="AEN477"
2200 ></A
2201 ><BLOCKQUOTE
2202 CLASS="BLOCKQUOTE"
2203 ><P
2204 >admin</P
2205 ></BLOCKQUOTE
2206 ></P
2207 ><P
2208 >Parameters:</P
2209 ><P
2210 ></P
2211 ><UL
2212 ><LI
2213 ><P
2214 >&#13;                          <CODE
2215 CLASS="parameter"
2216 >auth</CODE
2217 >
2218 : struct, API authentication structure                  </P
2219 ><P
2220 ></P
2221 ><UL
2222 ><LI
2223 ><P
2224 >&#13;                                          <CODE
2225 CLASS="parameter"
2226 >AuthMethod</CODE
2227 >
2228 : string, Authentication method to use                                  </P
2229 ></LI
2230 ></UL
2231 ></LI
2232 ><LI
2233 ><P
2234 >&#13;                          <CODE
2235 CLASS="parameter"
2236 >nodegroup_fields</CODE
2237 >
2238 : struct                        </P
2239 ><P
2240 ></P
2241 ><UL
2242 ><LI
2243 ><P
2244 >&#13;                                          <CODE
2245 CLASS="parameter"
2246 >name</CODE
2247 >
2248 : string, Node group name                                       </P
2249 ></LI
2250 ><LI
2251 ><P
2252 >&#13;                                          <CODE
2253 CLASS="parameter"
2254 >description</CODE
2255 >
2256 : string, Node group description                                        </P
2257 ></LI
2258 ></UL
2259 ></LI
2260 ></UL
2261 ><P
2262 >Returns:</P
2263 ><P
2264 ></P
2265 ><UL
2266 ><LI
2267 ><P
2268 >&#13;int, New nodegroup_id (&#62; 0) if successful                     </P
2269 ></LI
2270 ></UL
2271 ></DIV
2272 ><DIV
2273 CLASS="section"
2274 ><HR><H2
2275 CLASS="section"
2276 ><A
2277 NAME="AddNodeNetwork"
2278 >2.12. AddNodeNetwork</A
2279 ></H2
2280 ><P
2281 >Prototype:<A
2282 NAME="AEN505"
2283 ></A
2284 ><BLOCKQUOTE
2285 CLASS="BLOCKQUOTE"
2286 ><P
2287 >AddNodeNetwork (auth, node_id_or_hostname, nodenetwork_fields)</P
2288 ></BLOCKQUOTE
2289 ></P
2290 ><P
2291 >Description:<A
2292 NAME="AEN508"
2293 ></A
2294 ><BLOCKQUOTE
2295 CLASS="BLOCKQUOTE"
2296 ><P
2297 >Adds a new network for a node. Any values specified in
2298 nodenetwork_fields are used, otherwise defaults are
2299 used. Acceptable values for method may be retrieved via
2300 GetNetworkMethods. Acceptable values for type may be retrieved via
2301 GetNetworkTypes.</P
2302 ><P
2303 >If type is static, ip, gateway, network, broadcast, netmask, and
2304 dns1 must all be specified in nodenetwork_fields. If type is dhcp,
2305 these parameters, even if specified, are ignored.</P
2306 ><P
2307 >PIs and techs may only add networks to their own nodes. Admins may
2308 add networks to any node.</P
2309 ><P
2310 >Returns the new nodenetwork_id (&#62; 0) if successful, faults otherwise.</P
2311 ></BLOCKQUOTE
2312 ></P
2313 ><P
2314 >Allowed Roles:<A
2315 NAME="AEN514"
2316 ></A
2317 ><BLOCKQUOTE
2318 CLASS="BLOCKQUOTE"
2319 ><P
2320 >admin, pi, tech</P
2321 ></BLOCKQUOTE
2322 ></P
2323 ><P
2324 >Parameters:</P
2325 ><P
2326 ></P
2327 ><UL
2328 ><LI
2329 ><P
2330 >&#13;                          <CODE
2331 CLASS="parameter"
2332 >auth</CODE
2333 >
2334 : struct, API authentication structure                  </P
2335 ><P
2336 ></P
2337 ><UL
2338 ><LI
2339 ><P
2340 >&#13;                                          <CODE
2341 CLASS="parameter"
2342 >AuthMethod</CODE
2343 >
2344 : string, Authentication method to use                                  </P
2345 ></LI
2346 ></UL
2347 ></LI
2348 ><LI
2349 ><P
2350 >&#13;                          <CODE
2351 CLASS="parameter"
2352 >node_id_or_hostname</CODE
2353 >
2354 : int or string                 </P
2355 ><P
2356 ></P
2357 ><UL
2358 ><LI
2359 ><P
2360 >&#13;int, Node identifier                                      </P
2361 ></LI
2362 ><LI
2363 ><P
2364 >&#13;string, Fully qualified hostname                                  </P
2365 ></LI
2366 ></UL
2367 ></LI
2368 ><LI
2369 ><P
2370 >&#13;                          <CODE
2371 CLASS="parameter"
2372 >nodenetwork_fields</CODE
2373 >
2374 : struct                        </P
2375 ><P
2376 ></P
2377 ><UL
2378 ><LI
2379 ><P
2380 >&#13;                                          <CODE
2381 CLASS="parameter"
2382 >network</CODE
2383 >
2384 : string, Subnet address                                        </P
2385 ></LI
2386 ><LI
2387 ><P
2388 >&#13;                                          <CODE
2389 CLASS="parameter"
2390 >is_primary</CODE
2391 >
2392 : boolean, Is the primary interface for this node                                       </P
2393 ></LI
2394 ><LI
2395 ><P
2396 >&#13;                                          <CODE
2397 CLASS="parameter"
2398 >dns1</CODE
2399 >
2400 : string, IP address of primary DNS server                                      </P
2401 ></LI
2402 ><LI
2403 ><P
2404 >&#13;                                          <CODE
2405 CLASS="parameter"
2406 >hostname</CODE
2407 >
2408 : string, (Optional) Hostname                                   </P
2409 ></LI
2410 ><LI
2411 ><P
2412 >&#13;                                          <CODE
2413 CLASS="parameter"
2414 >mac</CODE
2415 >
2416 : string, MAC address                                   </P
2417 ></LI
2418 ><LI
2419 ><P
2420 >&#13;                                          <CODE
2421 CLASS="parameter"
2422 >bwlimit</CODE
2423 >
2424 : int, Bandwidth limit                                  </P
2425 ></LI
2426 ><LI
2427 ><P
2428 >&#13;                                          <CODE
2429 CLASS="parameter"
2430 >broadcast</CODE
2431 >
2432 : string, Network broadcast address                                     </P
2433 ></LI
2434 ><LI
2435 ><P
2436 >&#13;                                          <CODE
2437 CLASS="parameter"
2438 >method</CODE
2439 >
2440 : string, Addressing method (e.g., 'static' or 'dhcp')                                  </P
2441 ></LI
2442 ><LI
2443 ><P
2444 >&#13;                                          <CODE
2445 CLASS="parameter"
2446 >netmask</CODE
2447 >
2448 : string, Subnet mask                                   </P
2449 ></LI
2450 ><LI
2451 ><P
2452 >&#13;                                          <CODE
2453 CLASS="parameter"
2454 >dns2</CODE
2455 >
2456 : string, IP address of secondary DNS server                                    </P
2457 ></LI
2458 ><LI
2459 ><P
2460 >&#13;                                          <CODE
2461 CLASS="parameter"
2462 >ip</CODE
2463 >
2464 : string, IP address                                    </P
2465 ></LI
2466 ><LI
2467 ><P
2468 >&#13;                                          <CODE
2469 CLASS="parameter"
2470 >type</CODE
2471 >
2472 : string, Address type (e.g., 'ipv4')                                   </P
2473 ></LI
2474 ><LI
2475 ><P
2476 >&#13;                                          <CODE
2477 CLASS="parameter"
2478 >gateway</CODE
2479 >
2480 : string, IP address of primary gateway                                 </P
2481 ></LI
2482 ></UL
2483 ></LI
2484 ></UL
2485 ><P
2486 >Returns:</P
2487 ><P
2488 ></P
2489 ><UL
2490 ><LI
2491 ><P
2492 >&#13;int, New nodenetwork_id (&#62; 0) if successful                   </P
2493 ></LI
2494 ></UL
2495 ></DIV
2496 ><DIV
2497 CLASS="section"
2498 ><HR><H2
2499 CLASS="section"
2500 ><A
2501 NAME="AddNode"
2502 >2.13. AddNode</A
2503 ></H2
2504 ><P
2505 >Prototype:<A
2506 NAME="AEN583"
2507 ></A
2508 ><BLOCKQUOTE
2509 CLASS="BLOCKQUOTE"
2510 ><P
2511 >AddNode (auth, site_id_or_login_base, node_fields)</P
2512 ></BLOCKQUOTE
2513 ></P
2514 ><P
2515 >Description:<A
2516 NAME="AEN586"
2517 ></A
2518 ><BLOCKQUOTE
2519 CLASS="BLOCKQUOTE"
2520 ><P
2521 >Adds a new node. Any values specified in node_fields are used,
2522 otherwise defaults are used.</P
2523 ><P
2524 >PIs and techs may only add nodes to their own sites. Admins may
2525 add nodes to any site.</P
2526 ><P
2527 >Returns the new node_id (&#62; 0) if successful, faults otherwise.</P
2528 ></BLOCKQUOTE
2529 ></P
2530 ><P
2531 >Allowed Roles:<A
2532 NAME="AEN591"
2533 ></A
2534 ><BLOCKQUOTE
2535 CLASS="BLOCKQUOTE"
2536 ><P
2537 >admin, pi, tech</P
2538 ></BLOCKQUOTE
2539 ></P
2540 ><P
2541 >Parameters:</P
2542 ><P
2543 ></P
2544 ><UL
2545 ><LI
2546 ><P
2547 >&#13;                          <CODE
2548 CLASS="parameter"
2549 >auth</CODE
2550 >
2551 : struct, API authentication structure                  </P
2552 ><P
2553 ></P
2554 ><UL
2555 ><LI
2556 ><P
2557 >&#13;                                          <CODE
2558 CLASS="parameter"
2559 >AuthMethod</CODE
2560 >
2561 : string, Authentication method to use                                  </P
2562 ></LI
2563 ></UL
2564 ></LI
2565 ><LI
2566 ><P
2567 >&#13;                          <CODE
2568 CLASS="parameter"
2569 >site_id_or_login_base</CODE
2570 >
2571 : int or string                 </P
2572 ><P
2573 ></P
2574 ><UL
2575 ><LI
2576 ><P
2577 >&#13;int, Site identifier                                      </P
2578 ></LI
2579 ><LI
2580 ><P
2581 >&#13;string, Site slice prefix                                 </P
2582 ></LI
2583 ></UL
2584 ></LI
2585 ><LI
2586 ><P
2587 >&#13;                          <CODE
2588 CLASS="parameter"
2589 >node_fields</CODE
2590 >
2591 : struct                        </P
2592 ><P
2593 ></P
2594 ><UL
2595 ><LI
2596 ><P
2597 >&#13;                                          <CODE
2598 CLASS="parameter"
2599 >boot_state</CODE
2600 >
2601 : string, Boot state                                    </P
2602 ></LI
2603 ><LI
2604 ><P
2605 >&#13;                                          <CODE
2606 CLASS="parameter"
2607 >model</CODE
2608 >
2609 : string, Make and model of the actual machine                                  </P
2610 ></LI
2611 ><LI
2612 ><P
2613 >&#13;                                          <CODE
2614 CLASS="parameter"
2615 >version</CODE
2616 >
2617 : string, Apparent Boot CD version                                      </P
2618 ></LI
2619 ><LI
2620 ><P
2621 >&#13;                                          <CODE
2622 CLASS="parameter"
2623 >hostname</CODE
2624 >
2625 : string, Fully qualified hostname                                      </P
2626 ></LI
2627 ></UL
2628 ></LI
2629 ></UL
2630 ><P
2631 >Returns:</P
2632 ><P
2633 ></P
2634 ><UL
2635 ><LI
2636 ><P
2637 >&#13;int, New node_id (&#62; 0) if successful                  </P
2638 ></LI
2639 ></UL
2640 ></DIV
2641 ><DIV
2642 CLASS="section"
2643 ><HR><H2
2644 CLASS="section"
2645 ><A
2646 NAME="AddNodeToNodeGroup"
2647 >2.14. AddNodeToNodeGroup</A
2648 ></H2
2649 ><P
2650 >Prototype:<A
2651 NAME="AEN633"
2652 ></A
2653 ><BLOCKQUOTE
2654 CLASS="BLOCKQUOTE"
2655 ><P
2656 >AddNodeToNodeGroup (auth, node_id_or_hostname, nodegroup_id_or_name)</P
2657 ></BLOCKQUOTE
2658 ></P
2659 ><P
2660 >Description:<A
2661 NAME="AEN636"
2662 ></A
2663 ><BLOCKQUOTE
2664 CLASS="BLOCKQUOTE"
2665 ><P
2666 >Add a node to the specified node group. If the node is
2667 already a member of the nodegroup, no errors are returned.</P
2668 ><P
2669 >Returns 1 if successful, faults otherwise.</P
2670 ></BLOCKQUOTE
2671 ></P
2672 ><P
2673 >Allowed Roles:<A
2674 NAME="AEN640"
2675 ></A
2676 ><BLOCKQUOTE
2677 CLASS="BLOCKQUOTE"
2678 ><P
2679 >admin</P
2680 ></BLOCKQUOTE
2681 ></P
2682 ><P
2683 >Parameters:</P
2684 ><P
2685 ></P
2686 ><UL
2687 ><LI
2688 ><P
2689 >&#13;                          <CODE
2690 CLASS="parameter"
2691 >auth</CODE
2692 >
2693 : struct, API authentication structure                  </P
2694 ><P
2695 ></P
2696 ><UL
2697 ><LI
2698 ><P
2699 >&#13;                                          <CODE
2700 CLASS="parameter"
2701 >AuthMethod</CODE
2702 >
2703 : string, Authentication method to use                                  </P
2704 ></LI
2705 ></UL
2706 ></LI
2707 ><LI
2708 ><P
2709 >&#13;                          <CODE
2710 CLASS="parameter"
2711 >node_id_or_hostname</CODE
2712 >
2713 : int or string                 </P
2714 ><P
2715 ></P
2716 ><UL
2717 ><LI
2718 ><P
2719 >&#13;int, Node identifier                                      </P
2720 ></LI
2721 ><LI
2722 ><P
2723 >&#13;string, Fully qualified hostname                                  </P
2724 ></LI
2725 ></UL
2726 ></LI
2727 ><LI
2728 ><P
2729 >&#13;                          <CODE
2730 CLASS="parameter"
2731 >nodegroup_id_or_name</CODE
2732 >
2733 : int or string                 </P
2734 ><P
2735 ></P
2736 ><UL
2737 ><LI
2738 ><P
2739 >&#13;int, Node group identifier                                        </P
2740 ></LI
2741 ><LI
2742 ><P
2743 >&#13;string, Node group name                                   </P
2744 ></LI
2745 ></UL
2746 ></LI
2747 ></UL
2748 ><P
2749 >Returns:</P
2750 ><P
2751 ></P
2752 ><UL
2753 ><LI
2754 ><P
2755 >&#13;int, 1 if successful                      </P
2756 ></LI
2757 ></UL
2758 ></DIV
2759 ><DIV
2760 CLASS="section"
2761 ><HR><H2
2762 CLASS="section"
2763 ><A
2764 NAME="AddNodeToPCU"
2765 >2.15. AddNodeToPCU</A
2766 ></H2
2767 ><P
2768 >Prototype:<A
2769 NAME="AEN674"
2770 ></A
2771 ><BLOCKQUOTE
2772 CLASS="BLOCKQUOTE"
2773 ><P
2774 >AddNodeToPCU (auth, node_id_or_hostname, pcu_id, port)</P
2775 ></BLOCKQUOTE
2776 ></P
2777 ><P
2778 >Description:<A
2779 NAME="AEN677"
2780 ></A
2781 ><BLOCKQUOTE
2782 CLASS="BLOCKQUOTE"
2783 ><P
2784 >Adds a node to a port on a PCU. Faults if the node has already
2785 been added to the PCU or if the port is already in use.</P
2786 ><P
2787 >Non-admins may only update PCUs at their sites.</P
2788 ><P
2789 >Returns 1 if successful, faults otherwise.</P
2790 ></BLOCKQUOTE
2791 ></P
2792 ><P
2793 >Allowed Roles:<A
2794 NAME="AEN682"
2795 ></A
2796 ><BLOCKQUOTE
2797 CLASS="BLOCKQUOTE"
2798 ><P
2799 >admin, pi, tech</P
2800 ></BLOCKQUOTE
2801 ></P
2802 ><P
2803 >Parameters:</P
2804 ><P
2805 ></P
2806 ><UL
2807 ><LI
2808 ><P
2809 >&#13;                          <CODE
2810 CLASS="parameter"
2811 >auth</CODE
2812 >
2813 : struct, API authentication structure                  </P
2814 ><P
2815 ></P
2816 ><UL
2817 ><LI
2818 ><P
2819 >&#13;                                          <CODE
2820 CLASS="parameter"
2821 >AuthMethod</CODE
2822 >
2823 : string, Authentication method to use                                  </P
2824 ></LI
2825 ></UL
2826 ></LI
2827 ><LI
2828 ><P
2829 >&#13;                          <CODE
2830 CLASS="parameter"
2831 >node_id_or_hostname</CODE
2832 >
2833 : int or string                 </P
2834 ><P
2835 ></P
2836 ><UL
2837 ><LI
2838 ><P
2839 >&#13;int, Node identifier                                      </P
2840 ></LI
2841 ><LI
2842 ><P
2843 >&#13;string, Fully qualified hostname                                  </P
2844 ></LI
2845 ></UL
2846 ></LI
2847 ><LI
2848 ><P
2849 >&#13;                          <CODE
2850 CLASS="parameter"
2851 >pcu_id</CODE
2852 >
2853 : int, PCU identifier                   </P
2854 ></LI
2855 ><LI
2856 ><P
2857 >&#13;                          <CODE
2858 CLASS="parameter"
2859 >port</CODE
2860 >
2861 : int, PCU port number                  </P
2862 ></LI
2863 ></UL
2864 ><P
2865 >Returns:</P
2866 ><P
2867 ></P
2868 ><UL
2869 ><LI
2870 ><P
2871 >&#13;int, 1 if successful                      </P
2872 ></LI
2873 ></UL
2874 ></DIV
2875 ><DIV
2876 CLASS="section"
2877 ><HR><H2
2878 CLASS="section"
2879 ><A
2880 NAME="AddPCU"
2881 >2.16. AddPCU</A
2882 ></H2
2883 ><P
2884 >Prototype:<A
2885 NAME="AEN714"
2886 ></A
2887 ><BLOCKQUOTE
2888 CLASS="BLOCKQUOTE"
2889 ><P
2890 >AddPCU (auth, site_id_or_login_base, pcu_fields)</P
2891 ></BLOCKQUOTE
2892 ></P
2893 ><P
2894 >Description:<A
2895 NAME="AEN717"
2896 ></A
2897 ><BLOCKQUOTE
2898 CLASS="BLOCKQUOTE"
2899 ><P
2900 >Adds a new power control unit (PCU) to the specified site. Any
2901 fields specified in pcu_fields are used, otherwise defaults are
2902 used.</P
2903 ><P
2904 >PIs and technical contacts may only add PCUs to their own sites.</P
2905 ><P
2906 >Returns the new pcu_id (&#62; 0) if successful, faults otherwise.</P
2907 ></BLOCKQUOTE
2908 ></P
2909 ><P
2910 >Allowed Roles:<A
2911 NAME="AEN722"
2912 ></A
2913 ><BLOCKQUOTE
2914 CLASS="BLOCKQUOTE"
2915 ><P
2916 >admin, pi, tech</P
2917 ></BLOCKQUOTE
2918 ></P
2919 ><P
2920 >Parameters:</P
2921 ><P
2922 ></P
2923 ><UL
2924 ><LI
2925 ><P
2926 >&#13;                          <CODE
2927 CLASS="parameter"
2928 >auth</CODE
2929 >
2930 : struct, API authentication structure                  </P
2931 ><P
2932 ></P
2933 ><UL
2934 ><LI
2935 ><P
2936 >&#13;                                          <CODE
2937 CLASS="parameter"
2938 >AuthMethod</CODE
2939 >
2940 : string, Authentication method to use                                  </P
2941 ></LI
2942 ></UL
2943 ></LI
2944 ><LI
2945 ><P
2946 >&#13;                          <CODE
2947 CLASS="parameter"
2948 >site_id_or_login_base</CODE
2949 >
2950 : int or string                 </P
2951 ><P
2952 ></P
2953 ><UL
2954 ><LI
2955 ><P
2956 >&#13;int, Site identifier                                      </P
2957 ></LI
2958 ><LI
2959 ><P
2960 >&#13;string, Site slice prefix                                 </P
2961 ></LI
2962 ></UL
2963 ></LI
2964 ><LI
2965 ><P
2966 >&#13;                          <CODE
2967 CLASS="parameter"
2968 >pcu_fields</CODE
2969 >
2970 : struct                        </P
2971 ><P
2972 ></P
2973 ><UL
2974 ><LI
2975 ><P
2976 >&#13;                                          <CODE
2977 CLASS="parameter"
2978 >username</CODE
2979 >
2980 : string, PCU username                                  </P
2981 ></LI
2982 ><LI
2983 ><P
2984 >&#13;                                          <CODE
2985 CLASS="parameter"
2986 >protocol</CODE
2987 >
2988 : string, PCU protocol, e.g. ssh, https, telnet                                 </P
2989 ></LI
2990 ><LI
2991 ><P
2992 >&#13;                                          <CODE
2993 CLASS="parameter"
2994 >ip</CODE
2995 >
2996 : string, PCU IP address                                        </P
2997 ></LI
2998 ><LI
2999 ><P
3000 >&#13;                                          <CODE
3001 CLASS="parameter"
3002 >notes</CODE
3003 >
3004 : string, Miscellaneous notes                                   </P
3005 ></LI
3006 ><LI
3007 ><P
3008 >&#13;                                          <CODE
3009 CLASS="parameter"
3010 >hostname</CODE
3011 >
3012 : string, PCU hostname                                  </P
3013 ></LI
3014 ><LI
3015 ><P
3016 >&#13;                                          <CODE
3017 CLASS="parameter"
3018 >model</CODE
3019 >
3020 : string, PCU model string                                      </P
3021 ></LI
3022 ><LI
3023 ><P
3024 >&#13;                                          <CODE
3025 CLASS="parameter"
3026 >password</CODE
3027 >
3028 : string, PCU username                                  </P
3029 ></LI
3030 ></UL
3031 ></LI
3032 ></UL
3033 ><P
3034 >Returns:</P
3035 ><P
3036 ></P
3037 ><UL
3038 ><LI
3039 ><P
3040 >&#13;int, New pcu_id (&#62; 0) if successful                   </P
3041 ></LI
3042 ></UL
3043 ></DIV
3044 ><DIV
3045 CLASS="section"
3046 ><HR><H2
3047 CLASS="section"
3048 ><A
3049 NAME="AddPeer"
3050 >2.17. AddPeer</A
3051 ></H2
3052 ><P
3053 >Prototype:<A
3054 NAME="AEN773"
3055 ></A
3056 ><BLOCKQUOTE
3057 CLASS="BLOCKQUOTE"
3058 ><P
3059 >AddPeer (auth, peer_fields)</P
3060 ></BLOCKQUOTE
3061 ></P
3062 ><P
3063 >Description:<A
3064 NAME="AEN776"
3065 ></A
3066 ><BLOCKQUOTE
3067 CLASS="BLOCKQUOTE"
3068 ><P
3069 >Adds a new peer.</P
3070 ><P
3071 >Returns the new peer_id (&#62; 0) if successful, faults otherwise.</P
3072 ></BLOCKQUOTE
3073 ></P
3074 ><P
3075 >Allowed Roles:<A
3076 NAME="AEN780"
3077 ></A
3078 ><BLOCKQUOTE
3079 CLASS="BLOCKQUOTE"
3080 ><P
3081 >admin</P
3082 ></BLOCKQUOTE
3083 ></P
3084 ><P
3085 >Parameters:</P
3086 ><P
3087 ></P
3088 ><UL
3089 ><LI
3090 ><P
3091 >&#13;                          <CODE
3092 CLASS="parameter"
3093 >auth</CODE
3094 >
3095 : struct, API authentication structure                  </P
3096 ><P
3097 ></P
3098 ><UL
3099 ><LI
3100 ><P
3101 >&#13;                                          <CODE
3102 CLASS="parameter"
3103 >AuthMethod</CODE
3104 >
3105 : string, Authentication method to use                                  </P
3106 ></LI
3107 ></UL
3108 ></LI
3109 ><LI
3110 ><P
3111 >&#13;                          <CODE
3112 CLASS="parameter"
3113 >peer_fields</CODE
3114 >
3115 : struct                        </P
3116 ><P
3117 ></P
3118 ><UL
3119 ><LI
3120 ><P
3121 >&#13;                                          <CODE
3122 CLASS="parameter"
3123 >key</CODE
3124 >
3125 : string, Peer GPG public key                                   </P
3126 ></LI
3127 ><LI
3128 ><P
3129 >&#13;                                          <CODE
3130 CLASS="parameter"
3131 >cacert</CODE
3132 >
3133 : string, Peer SSL public certificate                                   </P
3134 ></LI
3135 ><LI
3136 ><P
3137 >&#13;                                          <CODE
3138 CLASS="parameter"
3139 >peername</CODE
3140 >
3141 : string, Peer name                                     </P
3142 ></LI
3143 ><LI
3144 ><P
3145 >&#13;                                          <CODE
3146 CLASS="parameter"
3147 >peer_url</CODE
3148 >
3149 : string, Peer API URL                                  </P
3150 ></LI
3151 ></UL
3152 ></LI
3153 ></UL
3154 ><P
3155 >Returns:</P
3156 ><P
3157 ></P
3158 ><UL
3159 ><LI
3160 ><P
3161 >&#13;int, New peer_id (&#62; 0) if successful                  </P
3162 ></LI
3163 ></UL
3164 ></DIV
3165 ><DIV
3166 CLASS="section"
3167 ><HR><H2
3168 CLASS="section"
3169 ><A
3170 NAME="AddPersonKey"
3171 >2.18. AddPersonKey</A
3172 ></H2
3173 ><P
3174 >Prototype:<A
3175 NAME="AEN814"
3176 ></A
3177 ><BLOCKQUOTE
3178 CLASS="BLOCKQUOTE"
3179 ><P
3180 >AddPersonKey (auth, person_id_or_email, key_fields)</P
3181 ></BLOCKQUOTE
3182 ></P
3183 ><P
3184 >Description:<A
3185 NAME="AEN817"
3186 ></A
3187 ><BLOCKQUOTE
3188 CLASS="BLOCKQUOTE"
3189 ><P
3190 >Adds a new key to the specified account.</P
3191 ><P
3192 >Non-admins can only modify their own keys.</P
3193 ><P
3194 >Returns the new key_id (&#62; 0) if successful, faults otherwise.</P
3195 ></BLOCKQUOTE
3196 ></P
3197 ><P
3198 >Allowed Roles:<A
3199 NAME="AEN822"
3200 ></A
3201 ><BLOCKQUOTE
3202 CLASS="BLOCKQUOTE"
3203 ><P
3204 >admin, pi, tech, user</P
3205 ></BLOCKQUOTE
3206 ></P
3207 ><P
3208 >Parameters:</P
3209 ><P
3210 ></P
3211 ><UL
3212 ><LI
3213 ><P
3214 >&#13;                          <CODE
3215 CLASS="parameter"
3216 >auth</CODE
3217 >
3218 : struct, API authentication structure                  </P
3219 ><P
3220 ></P
3221 ><UL
3222 ><LI
3223 ><P
3224 >&#13;                                          <CODE
3225 CLASS="parameter"
3226 >AuthMethod</CODE
3227 >
3228 : string, Authentication method to use                                  </P
3229 ></LI
3230 ></UL
3231 ></LI
3232 ><LI
3233 ><P
3234 >&#13;                          <CODE
3235 CLASS="parameter"
3236 >person_id_or_email</CODE
3237 >
3238 : int or string                 </P
3239 ><P
3240 ></P
3241 ><UL
3242 ><LI
3243 ><P
3244 >&#13;int, User identifier                                      </P
3245 ></LI
3246 ><LI
3247 ><P
3248 >&#13;string, Primary e-mail address                                    </P
3249 ></LI
3250 ></UL
3251 ></LI
3252 ><LI
3253 ><P
3254 >&#13;                          <CODE
3255 CLASS="parameter"
3256 >key_fields</CODE
3257 >
3258 : struct                        </P
3259 ><P
3260 ></P
3261 ><UL
3262 ><LI
3263 ><P
3264 >&#13;                                          <CODE
3265 CLASS="parameter"
3266 >key_type</CODE
3267 >
3268 : string, Key type                                      </P
3269 ></LI
3270 ><LI
3271 ><P
3272 >&#13;                                          <CODE
3273 CLASS="parameter"
3274 >key</CODE
3275 >
3276 : string, Key value                                     </P
3277 ></LI
3278 ></UL
3279 ></LI
3280 ></UL
3281 ><P
3282 >Returns:</P
3283 ><P
3284 ></P
3285 ><UL
3286 ><LI
3287 ><P
3288 >&#13;int, New key_id (&#62; 0) if successful                   </P
3289 ></LI
3290 ></UL
3291 ></DIV
3292 ><DIV
3293 CLASS="section"
3294 ><HR><H2
3295 CLASS="section"
3296 ><A
3297 NAME="AddPerson"
3298 >2.19. AddPerson</A
3299 ></H2
3300 ><P
3301 >Prototype:<A
3302 NAME="AEN858"
3303 ></A
3304 ><BLOCKQUOTE
3305 CLASS="BLOCKQUOTE"
3306 ><P
3307 >AddPerson (auth, person_fields)</P
3308 ></BLOCKQUOTE
3309 ></P
3310 ><P
3311 >Description:<A
3312 NAME="AEN861"
3313 ></A
3314 ><BLOCKQUOTE
3315 CLASS="BLOCKQUOTE"
3316 ><P
3317 >Adds a new account. Any fields specified in person_fields are
3318 used, otherwise defaults are used.</P
3319 ><P
3320 >Accounts are disabled by default. To enable an account, use
3321 UpdatePerson().</P
3322 ><P
3323 >Returns the new person_id (&#62; 0) if successful, faults otherwise.</P
3324 ></BLOCKQUOTE
3325 ></P
3326 ><P
3327 >Allowed Roles:<A
3328 NAME="AEN866"
3329 ></A
3330 ><BLOCKQUOTE
3331 CLASS="BLOCKQUOTE"
3332 ><P
3333 >admin, pi</P
3334 ></BLOCKQUOTE
3335 ></P
3336 ><P
3337 >Parameters:</P
3338 ><P
3339 ></P
3340 ><UL
3341 ><LI
3342 ><P
3343 >&#13;                          <CODE
3344 CLASS="parameter"
3345 >auth</CODE
3346 >
3347 : struct, API authentication structure                  </P
3348 ><P
3349 ></P
3350 ><UL
3351 ><LI
3352 ><P
3353 >&#13;                                          <CODE
3354 CLASS="parameter"
3355 >AuthMethod</CODE
3356 >
3357 : string, Authentication method to use                                  </P
3358 ></LI
3359 ></UL
3360 ></LI
3361 ><LI
3362 ><P
3363 >&#13;                          <CODE
3364 CLASS="parameter"
3365 >person_fields</CODE
3366 >
3367 : struct                        </P
3368 ><P
3369 ></P
3370 ><UL
3371 ><LI
3372 ><P
3373 >&#13;                                          <CODE
3374 CLASS="parameter"
3375 >bio</CODE
3376 >
3377 : string, Biography                                     </P
3378 ></LI
3379 ><LI
3380 ><P
3381 >&#13;                                          <CODE
3382 CLASS="parameter"
3383 >first_name</CODE
3384 >
3385 : string, Given name                                    </P
3386 ></LI
3387 ><LI
3388 ><P
3389 >&#13;                                          <CODE
3390 CLASS="parameter"
3391 >last_name</CODE
3392 >
3393 : string, Surname                                       </P
3394 ></LI
3395 ><LI
3396 ><P
3397 >&#13;                                          <CODE
3398 CLASS="parameter"
3399 >title</CODE
3400 >
3401 : string, Title                                 </P
3402 ></LI
3403 ><LI
3404 ><P
3405 >&#13;                                          <CODE
3406 CLASS="parameter"
3407 >url</CODE
3408 >
3409 : string, Home page                                     </P
3410 ></LI
3411 ><LI
3412 ><P
3413 >&#13;                                          <CODE
3414 CLASS="parameter"
3415 >phone</CODE
3416 >
3417 : string, Telephone number                                      </P
3418 ></LI
3419 ><LI
3420 ><P
3421 >&#13;                                          <CODE
3422 CLASS="parameter"
3423 >password</CODE
3424 >
3425 : string, Account password in crypt() form                                      </P
3426 ></LI
3427 ><LI
3428 ><P
3429 >&#13;                                          <CODE
3430 CLASS="parameter"
3431 >email</CODE
3432 >
3433 : string, Primary e-mail address                                        </P
3434 ></LI
3435 ></UL
3436 ></LI
3437 ></UL
3438 ><P
3439 >Returns:</P
3440 ><P
3441 ></P
3442 ><UL
3443 ><LI
3444 ><P
3445 >&#13;int, New person_id (&#62; 0) if successful                        </P
3446 ></LI
3447 ></UL
3448 ></DIV
3449 ><DIV
3450 CLASS="section"
3451 ><HR><H2
3452 CLASS="section"
3453 ><A
3454 NAME="AddPersonToSite"
3455 >2.20. AddPersonToSite</A
3456 ></H2
3457 ><P
3458 >Prototype:<A
3459 NAME="AEN912"
3460 ></A
3461 ><BLOCKQUOTE
3462 CLASS="BLOCKQUOTE"
3463 ><P
3464 >AddPersonToSite (auth, person_id_or_email, site_id_or_login_base)</P
3465 ></BLOCKQUOTE
3466 ></P
3467 ><P
3468 >Description:<A
3469 NAME="AEN915"
3470 ></A
3471 ><BLOCKQUOTE
3472 CLASS="BLOCKQUOTE"
3473 ><P
3474 >Adds the specified person to the specified site. If the person is
3475 already a member of the site, no errors are returned. Does not
3476 change the person's primary site.</P
3477 ><P
3478 >Returns 1 if successful, faults otherwise.</P
3479 ></BLOCKQUOTE
3480 ></P
3481 ><P
3482 >Allowed Roles:<A
3483 NAME="AEN919"
3484 ></A
3485 ><BLOCKQUOTE
3486 CLASS="BLOCKQUOTE"
3487 ><P
3488 >admin</P
3489 ></BLOCKQUOTE
3490 ></P
3491 ><P
3492 >Parameters:</P
3493 ><P
3494 ></P
3495 ><UL
3496 ><LI
3497 ><P
3498 >&#13;                          <CODE
3499 CLASS="parameter"
3500 >auth</CODE
3501 >
3502 : struct, API authentication structure                  </P
3503 ><P
3504 ></P
3505 ><UL
3506 ><LI
3507 ><P
3508 >&#13;                                          <CODE
3509 CLASS="parameter"
3510 >AuthMethod</CODE
3511 >
3512 : string, Authentication method to use                                  </P
3513 ></LI
3514 ></UL
3515 ></LI
3516 ><LI
3517 ><P
3518 >&#13;                          <CODE
3519 CLASS="parameter"
3520 >person_id_or_email</CODE
3521 >
3522 : int or string                 </P
3523 ><P
3524 ></P
3525 ><UL
3526 ><LI
3527 ><P
3528 >&#13;int, User identifier                                      </P
3529 ></LI
3530 ><LI
3531 ><P
3532 >&#13;string, Primary e-mail address                                    </P
3533 ></LI
3534 ></UL
3535 ></LI
3536 ><LI
3537 ><P
3538 >&#13;                          <CODE
3539 CLASS="parameter"
3540 >site_id_or_login_base</CODE
3541 >
3542 : int or string                 </P
3543 ><P
3544 ></P
3545 ><UL
3546 ><LI
3547 ><P
3548 >&#13;int, Site identifier                                      </P
3549 ></LI
3550 ><LI
3551 ><P
3552 >&#13;string, Site slice prefix                                 </P
3553 ></LI
3554 ></UL
3555 ></LI
3556 ></UL
3557 ><P
3558 >Returns:</P
3559 ><P
3560 ></P
3561 ><UL
3562 ><LI
3563 ><P
3564 >&#13;int, 1 if successful                      </P
3565 ></LI
3566 ></UL
3567 ></DIV
3568 ><DIV
3569 CLASS="section"
3570 ><HR><H2
3571 CLASS="section"
3572 ><A
3573 NAME="AddPersonToSlice"
3574 >2.21. AddPersonToSlice</A
3575 ></H2
3576 ><P
3577 >Prototype:<A
3578 NAME="AEN953"
3579 ></A
3580 ><BLOCKQUOTE
3581 CLASS="BLOCKQUOTE"
3582 ><P
3583 >AddPersonToSlice (auth, person_id_or_email, slice_id_or_name)</P
3584 ></BLOCKQUOTE
3585 ></P
3586 ><P
3587 >Description:<A
3588 NAME="AEN956"
3589 ></A
3590 ><BLOCKQUOTE
3591 CLASS="BLOCKQUOTE"
3592 ><P
3593 >Adds the specified person to the specified slice. If the person is
3594 already a member of the slice, no errors are returned.</P
3595 ><P
3596 >Returns 1 if successful, faults otherwise.</P
3597 ></BLOCKQUOTE
3598 ></P
3599 ><P
3600 >Allowed Roles:<A
3601 NAME="AEN960"
3602 ></A
3603 ><BLOCKQUOTE
3604 CLASS="BLOCKQUOTE"
3605 ><P
3606 >admin, pi</P
3607 ></BLOCKQUOTE
3608 ></P
3609 ><P
3610 >Parameters:</P
3611 ><P
3612 ></P
3613 ><UL
3614 ><LI
3615 ><P
3616 >&#13;                          <CODE
3617 CLASS="parameter"
3618 >auth</CODE
3619 >
3620 : struct, API authentication structure                  </P
3621 ><P
3622 ></P
3623 ><UL
3624 ><LI
3625 ><P
3626 >&#13;                                          <CODE
3627 CLASS="parameter"
3628 >AuthMethod</CODE
3629 >
3630 : string, Authentication method to use                                  </P
3631 ></LI
3632 ></UL
3633 ></LI
3634 ><LI
3635 ><P
3636 >&#13;                          <CODE
3637 CLASS="parameter"
3638 >person_id_or_email</CODE
3639 >
3640 : int or string                 </P
3641 ><P
3642 ></P
3643 ><UL
3644 ><LI
3645 ><P
3646 >&#13;int, User identifier                                      </P
3647 ></LI
3648 ><LI
3649 ><P
3650 >&#13;string, Primary e-mail address                                    </P
3651 ></LI
3652 ></UL
3653 ></LI
3654 ><LI
3655 ><P
3656 >&#13;                          <CODE
3657 CLASS="parameter"
3658 >slice_id_or_name</CODE
3659 >
3660 : int or string                 </P
3661 ><P
3662 ></P
3663 ><UL
3664 ><LI
3665 ><P
3666 >&#13;int, Slice identifier                                     </P
3667 ></LI
3668 ><LI
3669 ><P
3670 >&#13;string, Slice name                                        </P
3671 ></LI
3672 ></UL
3673 ></LI
3674 ></UL
3675 ><P
3676 >Returns:</P
3677 ><P
3678 ></P
3679 ><UL
3680 ><LI
3681 ><P
3682 >&#13;int, 1 if successful                      </P
3683 ></LI
3684 ></UL
3685 ></DIV
3686 ><DIV
3687 CLASS="section"
3688 ><HR><H2
3689 CLASS="section"
3690 ><A
3691 NAME="AddRole"
3692 >2.22. AddRole</A
3693 ></H2
3694 ><P
3695 >Prototype:<A
3696 NAME="AEN994"
3697 ></A
3698 ><BLOCKQUOTE
3699 CLASS="BLOCKQUOTE"
3700 ><P
3701 >AddRole (auth, role_id, name)</P
3702 ></BLOCKQUOTE
3703 ></P
3704 ><P
3705 >Description:<A
3706 NAME="AEN997"
3707 ></A
3708 ><BLOCKQUOTE
3709 CLASS="BLOCKQUOTE"
3710 ><P
3711 >Adds a new role.</P
3712 ><P
3713 >Returns 1 if successful, faults otherwise.</P
3714 ></BLOCKQUOTE
3715 ></P
3716 ><P
3717 >Allowed Roles:<A
3718 NAME="AEN1001"
3719 ></A
3720 ><BLOCKQUOTE
3721 CLASS="BLOCKQUOTE"
3722 ><P
3723 >admin</P
3724 ></BLOCKQUOTE
3725 ></P
3726 ><P
3727 >Parameters:</P
3728 ><P
3729 ></P
3730 ><UL
3731 ><LI
3732 ><P
3733 >&#13;                          <CODE
3734 CLASS="parameter"
3735 >auth</CODE
3736 >
3737 : struct, API authentication structure                  </P
3738 ><P
3739 ></P
3740 ><UL
3741 ><LI
3742 ><P
3743 >&#13;                                          <CODE
3744 CLASS="parameter"
3745 >AuthMethod</CODE
3746 >
3747 : string, Authentication method to use                                  </P
3748 ></LI
3749 ></UL
3750 ></LI
3751 ><LI
3752 ><P
3753 >&#13;                          <CODE
3754 CLASS="parameter"
3755 >role_id</CODE
3756 >
3757 : int, Role identifier                  </P
3758 ></LI
3759 ><LI
3760 ><P
3761 >&#13;                          <CODE
3762 CLASS="parameter"
3763 >name</CODE
3764 >
3765 : string, Role                  </P
3766 ></LI
3767 ></UL
3768 ><P
3769 >Returns:</P
3770 ><P
3771 ></P
3772 ><UL
3773 ><LI
3774 ><P
3775 >&#13;int, 1 if successful                      </P
3776 ></LI
3777 ></UL
3778 ></DIV
3779 ><DIV
3780 CLASS="section"
3781 ><HR><H2
3782 CLASS="section"
3783 ><A
3784 NAME="AddRoleToPerson"
3785 >2.23. AddRoleToPerson</A
3786 ></H2
3787 ><P
3788 >Prototype:<A
3789 NAME="AEN1025"
3790 ></A
3791 ><BLOCKQUOTE
3792 CLASS="BLOCKQUOTE"
3793 ><P
3794 >AddRoleToPerson (auth, role_id_or_name, person_id_or_email)</P
3795 ></BLOCKQUOTE
3796 ></P
3797 ><P
3798 >Description:<A
3799 NAME="AEN1028"
3800 ></A
3801 ><BLOCKQUOTE
3802 CLASS="BLOCKQUOTE"
3803 ><P
3804 >Grants the specified role to the person.</P
3805 ><P
3806 >PIs can only grant the tech and user roles to users and techs at
3807 their sites. Admins can grant any role to any user.</P
3808 ><P
3809 >Returns 1 if successful, faults otherwise.</P
3810 ></BLOCKQUOTE
3811 ></P
3812 ><P
3813 >Allowed Roles:<A
3814 NAME="AEN1033"
3815 ></A
3816 ><BLOCKQUOTE
3817 CLASS="BLOCKQUOTE"
3818 ><P
3819 >admin, pi</P
3820 ></BLOCKQUOTE
3821 ></P
3822 ><P
3823 >Parameters:</P
3824 ><P
3825 ></P
3826 ><UL
3827 ><LI
3828 ><P
3829 >&#13;                          <CODE
3830 CLASS="parameter"
3831 >auth</CODE
3832 >
3833 : struct, API authentication structure                  </P
3834 ><P
3835 ></P
3836 ><UL
3837 ><LI
3838 ><P
3839 >&#13;                                          <CODE
3840 CLASS="parameter"
3841 >AuthMethod</CODE
3842 >
3843 : string, Authentication method to use                                  </P
3844 ></LI
3845 ></UL
3846 ></LI
3847 ><LI
3848 ><P
3849 >&#13;                          <CODE
3850 CLASS="parameter"
3851 >role_id_or_name</CODE
3852 >
3853 : int or string                 </P
3854 ><P
3855 ></P
3856 ><UL
3857 ><LI
3858 ><P
3859 >&#13;int, Role identifier                                      </P
3860 ></LI
3861 ><LI
3862 ><P
3863 >&#13;string, Role                                      </P
3864 ></LI
3865 ></UL
3866 ></LI
3867 ><LI
3868 ><P
3869 >&#13;                          <CODE
3870 CLASS="parameter"
3871 >person_id_or_email</CODE
3872 >
3873 : int or string                 </P
3874 ><P
3875 ></P
3876 ><UL
3877 ><LI
3878 ><P
3879 >&#13;int, User identifier                                      </P
3880 ></LI
3881 ><LI
3882 ><P
3883 >&#13;string, Primary e-mail address                                    </P
3884 ></LI
3885 ></UL
3886 ></LI
3887 ></UL
3888 ><P
3889 >Returns:</P
3890 ><P
3891 ></P
3892 ><UL
3893 ><LI
3894 ><P
3895 >&#13;int, 1 if successful                      </P
3896 ></LI
3897 ></UL
3898 ></DIV
3899 ><DIV
3900 CLASS="section"
3901 ><HR><H2
3902 CLASS="section"
3903 ><A
3904 NAME="AddSiteAddress"
3905 >2.24. AddSiteAddress</A
3906 ></H2
3907 ><P
3908 >Prototype:<A
3909 NAME="AEN1067"
3910 ></A
3911 ><BLOCKQUOTE
3912 CLASS="BLOCKQUOTE"
3913 ><P
3914 >AddSiteAddress (auth, site_id_or_login_base, address_fields)</P
3915 ></BLOCKQUOTE
3916 ></P
3917 ><P
3918 >Description:<A
3919 NAME="AEN1070"
3920 ></A
3921 ><BLOCKQUOTE
3922 CLASS="BLOCKQUOTE"
3923 ><P
3924 >Adds a new address to a site. Fields specified in
3925 address_fields are used; some are not optional.</P
3926 ><P
3927 >PIs may only add addresses to their own sites.</P
3928 ><P
3929 >Returns the new address_id (&#62; 0) if successful, faults otherwise.</P
3930 ></BLOCKQUOTE
3931 ></P
3932 ><P
3933 >Allowed Roles:<A
3934 NAME="AEN1075"
3935 ></A
3936 ><BLOCKQUOTE
3937 CLASS="BLOCKQUOTE"
3938 ><P
3939 >admin, pi</P
3940 ></BLOCKQUOTE
3941 ></P
3942 ><P
3943 >Parameters:</P
3944 ><P
3945 ></P
3946 ><UL
3947 ><LI
3948 ><P
3949 >&#13;                          <CODE
3950 CLASS="parameter"
3951 >auth</CODE
3952 >
3953 : struct, API authentication structure                  </P
3954 ><P
3955 ></P
3956 ><UL
3957 ><LI
3958 ><P
3959 >&#13;                                          <CODE
3960 CLASS="parameter"
3961 >AuthMethod</CODE
3962 >
3963 : string, Authentication method to use                                  </P
3964 ></LI
3965 ></UL
3966 ></LI
3967 ><LI
3968 ><P
3969 >&#13;                          <CODE
3970 CLASS="parameter"
3971 >site_id_or_login_base</CODE
3972 >
3973 : int or string                 </P
3974 ><P
3975 ></P
3976 ><UL
3977 ><LI
3978 ><P
3979 >&#13;int, Site identifier                                      </P
3980 ></LI
3981 ><LI
3982 ><P
3983 >&#13;string, Site slice prefix                                 </P
3984 ></LI
3985 ></UL
3986 ></LI
3987 ><LI
3988 ><P
3989 >&#13;                          <CODE
3990 CLASS="parameter"
3991 >address_fields</CODE
3992 >
3993 : struct                        </P
3994 ><P
3995 ></P
3996 ><UL
3997 ><LI
3998 ><P
3999 >&#13;                                          <CODE
4000 CLASS="parameter"
4001 >city</CODE
4002 >
4003 : string, City                                  </P
4004 ></LI
4005 ><LI
4006 ><P
4007 >&#13;                                          <CODE
4008 CLASS="parameter"
4009 >country</CODE
4010 >
4011 : string, Country                                       </P
4012 ></LI
4013 ><LI
4014 ><P
4015 >&#13;                                          <CODE
4016 CLASS="parameter"
4017 >line3</CODE
4018 >
4019 : string, Address line 3                                        </P
4020 ></LI
4021 ><LI
4022 ><P
4023 >&#13;                                          <CODE
4024 CLASS="parameter"
4025 >line2</CODE
4026 >
4027 : string, Address line 2                                        </P
4028 ></LI
4029 ><LI
4030 ><P
4031 >&#13;                                          <CODE
4032 CLASS="parameter"
4033 >line1</CODE
4034 >
4035 : string, Address line 1                                        </P
4036 ></LI
4037 ><LI
4038 ><P
4039 >&#13;                                          <CODE
4040 CLASS="parameter"
4041 >state</CODE
4042 >
4043 : string, State or province                                     </P
4044 ></LI
4045 ><LI
4046 ><P
4047 >&#13;                                          <CODE
4048 CLASS="parameter"
4049 >postalcode</CODE
4050 >
4051 : string, Postal code                                   </P
4052 ></LI
4053 ></UL
4054 ></LI
4055 ></UL
4056 ><P
4057 >Returns:</P
4058 ><P
4059 ></P
4060 ><UL
4061 ><LI
4062 ><P
4063 >&#13;int, New address_id (&#62; 0) if successful                       </P
4064 ></LI
4065 ></UL
4066 ></DIV
4067 ><DIV
4068 CLASS="section"
4069 ><HR><H2
4070 CLASS="section"
4071 ><A
4072 NAME="AddSite"
4073 >2.25. AddSite</A
4074 ></H2
4075 ><P
4076 >Prototype:<A
4077 NAME="AEN1126"
4078 ></A
4079 ><BLOCKQUOTE
4080 CLASS="BLOCKQUOTE"
4081 ><P
4082 >AddSite (auth, site_fields)</P
4083 ></BLOCKQUOTE
4084 ></P
4085 ><P
4086 >Description:<A
4087 NAME="AEN1129"
4088 ></A
4089 ><BLOCKQUOTE
4090 CLASS="BLOCKQUOTE"
4091 ><P
4092 >Adds a new site, and creates a node group for that site. Any
4093 fields specified in site_fields are used, otherwise defaults are
4094 used.</P
4095 ><P
4096 >Returns the new site_id (&#62; 0) if successful, faults otherwise.</P
4097 ></BLOCKQUOTE
4098 ></P
4099 ><P
4100 >Allowed Roles:<A
4101 NAME="AEN1133"
4102 ></A
4103 ><BLOCKQUOTE
4104 CLASS="BLOCKQUOTE"
4105 ><P
4106 >admin</P
4107 ></BLOCKQUOTE
4108 ></P
4109 ><P
4110 >Parameters:</P
4111 ><P
4112 ></P
4113 ><UL
4114 ><LI
4115 ><P
4116 >&#13;                          <CODE
4117 CLASS="parameter"
4118 >auth</CODE
4119 >
4120 : struct, API authentication structure                  </P
4121 ><P
4122 ></P
4123 ><UL
4124 ><LI
4125 ><P
4126 >&#13;                                          <CODE
4127 CLASS="parameter"
4128 >AuthMethod</CODE
4129 >
4130 : string, Authentication method to use                                  </P
4131 ></LI
4132 ></UL
4133 ></LI
4134 ><LI
4135 ><P
4136 >&#13;                          <CODE
4137 CLASS="parameter"
4138 >site_fields</CODE
4139 >
4140 : struct                        </P
4141 ><P
4142 ></P
4143 ><UL
4144 ><LI
4145 ><P
4146 >&#13;                                          <CODE
4147 CLASS="parameter"
4148 >name</CODE
4149 >
4150 : string, Full site name                                        </P
4151 ></LI
4152 ><LI
4153 ><P
4154 >&#13;                                          <CODE
4155 CLASS="parameter"
4156 >url</CODE
4157 >
4158 : string, URL of a page that describes the site                                 </P
4159 ></LI
4160 ><LI
4161 ><P
4162 >&#13;                                          <CODE
4163 CLASS="parameter"
4164 >enabled</CODE
4165 >
4166 : boolean, Has been enabled                                     </P
4167 ></LI
4168 ><LI
4169 ><P
4170 >&#13;                                          <CODE
4171 CLASS="parameter"
4172 >longitude</CODE
4173 >
4174 : double, Decimal longitude of the site                                 </P
4175 ></LI
4176 ><LI
4177 ><P
4178 >&#13;                                          <CODE
4179 CLASS="parameter"
4180 >latitude</CODE
4181 >
4182 : double, Decimal latitude of the site                                  </P
4183 ></LI
4184 ><LI
4185 ><P
4186 >&#13;                                          <CODE
4187 CLASS="parameter"
4188 >max_slices</CODE
4189 >
4190 : int, Maximum number of slices that the site is able to create                                 </P
4191 ></LI
4192 ><LI
4193 ><P
4194 >&#13;                                          <CODE
4195 CLASS="parameter"
4196 >login_base</CODE
4197 >
4198 : string, Site slice prefix                                     </P
4199 ></LI
4200 ><LI
4201 ><P
4202 >&#13;                                          <CODE
4203 CLASS="parameter"
4204 >max_slivers</CODE
4205 >
4206 : int, Maximum number of slivers that the site is able to create                                        </P
4207 ></LI
4208 ><LI
4209 ><P
4210 >&#13;                                          <CODE
4211 CLASS="parameter"
4212 >is_public</CODE
4213 >
4214 : boolean, Publicly viewable site                                       </P
4215 ></LI
4216 ><LI
4217 ><P
4218 >&#13;                                          <CODE
4219 CLASS="parameter"
4220 >abbreviated_name</CODE
4221 >
4222 : string, Abbreviated site name                                 </P
4223 ></LI
4224 ></UL
4225 ></LI
4226 ></UL
4227 ><P
4228 >Returns:</P
4229 ><P
4230 ></P
4231 ><UL
4232 ><LI
4233 ><P
4234 >&#13;int, New site_id (&#62; 0) if successful                  </P
4235 ></LI
4236 ></UL
4237 ></DIV
4238 ><DIV
4239 CLASS="section"
4240 ><HR><H2
4241 CLASS="section"
4242 ><A
4243 NAME="AddSliceAttribute"
4244 >2.26. AddSliceAttribute</A
4245 ></H2
4246 ><P
4247 >Prototype:<A
4248 NAME="AEN1185"
4249 ></A
4250 ><BLOCKQUOTE
4251 CLASS="BLOCKQUOTE"
4252 ><P
4253 >AddSliceAttribute (auth, slice_id_or_name, attribute_type_id_or_name, value, node_id_or_hostname)</P
4254 ></BLOCKQUOTE
4255 ></P
4256 ><P
4257 >Description:<A
4258 NAME="AEN1188"
4259 ></A
4260 ><BLOCKQUOTE
4261 CLASS="BLOCKQUOTE"
4262 ><P
4263 >Sets the specified attribute of the slice (or sliver, if
4264 node_id_or_hostname is specified) to the specified value.</P
4265 ><P
4266 >Attributes may require the caller to have a particular role in
4267 order to be set or changed. Users may only set attributes of
4268 slices or slivers of which they are members. PIs may only set
4269 attributes of slices or slivers at their sites, or of which they
4270 are members. Admins may set attributes of any slice or sliver.</P
4271 ><P
4272 >Returns the new slice_attribute_id (&#62; 0) if successful, faults
4273 otherwise.</P
4274 ></BLOCKQUOTE
4275 ></P
4276 ><P
4277 >Allowed Roles:<A
4278 NAME="AEN1193"
4279 ></A
4280 ><BLOCKQUOTE
4281 CLASS="BLOCKQUOTE"
4282 ><P
4283 >admin, pi, user</P
4284 ></BLOCKQUOTE
4285 ></P
4286 ><P
4287 >Parameters:</P
4288 ><P
4289 ></P
4290 ><UL
4291 ><LI
4292 ><P
4293 >&#13;                          <CODE
4294 CLASS="parameter"
4295 >auth</CODE
4296 >
4297 : struct, API authentication structure                  </P
4298 ><P
4299 ></P
4300 ><UL
4301 ><LI
4302 ><P
4303 >&#13;                                          <CODE
4304 CLASS="parameter"
4305 >AuthMethod</CODE
4306 >
4307 : string, Authentication method to use                                  </P
4308 ></LI
4309 ></UL
4310 ></LI
4311 ><LI
4312 ><P
4313 >&#13;                          <CODE
4314 CLASS="parameter"
4315 >slice_id_or_name</CODE
4316 >
4317 : int or string                 </P
4318 ><P
4319 ></P
4320 ><UL
4321 ><LI
4322 ><P
4323 >&#13;int, Slice identifier                                     </P
4324 ></LI
4325 ><LI
4326 ><P
4327 >&#13;string, Slice attribute type name                                 </P
4328 ></LI
4329 ></UL
4330 ></LI
4331 ><LI
4332 ><P
4333 >&#13;                          <CODE
4334 CLASS="parameter"
4335 >attribute_type_id_or_name</CODE
4336 >
4337 : int or string                 </P
4338 ><P
4339 ></P
4340 ><UL
4341 ><LI
4342 ><P
4343 >&#13;int, Slice attribute type identifier                                      </P
4344 ></LI
4345 ><LI
4346 ><P
4347 >&#13;string, Slice attribute type name                                 </P
4348 ></LI
4349 ></UL
4350 ></LI
4351 ><LI
4352 ><P
4353 >&#13;                          <CODE
4354 CLASS="parameter"
4355 >value</CODE
4356 >
4357 : string, Slice attribute value                 </P
4358 ></LI
4359 ><LI
4360 ><P
4361 >&#13;                          <CODE
4362 CLASS="parameter"
4363 >node_id_or_hostname</CODE
4364 >
4365 : int or string                 </P
4366 ><P
4367 ></P
4368 ><UL
4369 ><LI
4370 ><P
4371 >&#13;int, Node identifier                                      </P
4372 ></LI
4373 ><LI
4374 ><P
4375 >&#13;string, Fully qualified hostname                                  </P
4376 ></LI
4377 ></UL
4378 ></LI
4379 ></UL
4380 ><P
4381 >Returns:</P
4382 ><P
4383 ></P
4384 ><UL
4385 ><LI
4386 ><P
4387 >&#13;int, New slice_attribute_id (&#62; 0) if successful                       </P
4388 ></LI
4389 ></UL
4390 ></DIV
4391 ><DIV
4392 CLASS="section"
4393 ><HR><H2
4394 CLASS="section"
4395 ><A
4396 NAME="AddSliceAttributeType"
4397 >2.27. AddSliceAttributeType</A
4398 ></H2
4399 ><P
4400 >Prototype:<A
4401 NAME="AEN1238"
4402 ></A
4403 ><BLOCKQUOTE
4404 CLASS="BLOCKQUOTE"
4405 ><P
4406 >AddSliceAttributeType (auth, attribute_type_fields)</P
4407 ></BLOCKQUOTE
4408 ></P
4409 ><P
4410 >Description:<A
4411 NAME="AEN1241"
4412 ></A
4413 ><BLOCKQUOTE
4414 CLASS="BLOCKQUOTE"
4415 ><P
4416 >Adds a new type of slice attribute. Any fields specified in
4417 attribute_type_fields are used, otherwise defaults are used.</P
4418 ><P
4419 >Returns the new attribute_type_id (&#62; 0) if successful, faults
4420 otherwise.</P
4421 ></BLOCKQUOTE
4422 ></P
4423 ><P
4424 >Allowed Roles:<A
4425 NAME="AEN1245"
4426 ></A
4427 ><BLOCKQUOTE
4428 CLASS="BLOCKQUOTE"
4429 ><P
4430 >admin</P
4431 ></BLOCKQUOTE
4432 ></P
4433 ><P
4434 >Parameters:</P
4435 ><P
4436 ></P
4437 ><UL
4438 ><LI
4439 ><P
4440 >&#13;                          <CODE
4441 CLASS="parameter"
4442 >auth</CODE
4443 >
4444 : struct, API authentication structure                  </P
4445 ><P
4446 ></P
4447 ><UL
4448 ><LI
4449 ><P
4450 >&#13;                                          <CODE
4451 CLASS="parameter"
4452 >AuthMethod</CODE
4453 >
4454 : string, Authentication method to use                                  </P
4455 ></LI
4456 ></UL
4457 ></LI
4458 ><LI
4459 ><P
4460 >&#13;                          <CODE
4461 CLASS="parameter"
4462 >attribute_type_fields</CODE
4463 >
4464 : struct                        </P
4465 ><P
4466 ></P
4467 ><UL
4468 ><LI
4469 ><P
4470 >&#13;                                          <CODE
4471 CLASS="parameter"
4472 >min_role_id</CODE
4473 >
4474 : int, Minimum (least powerful) role that can set or change this attribute                                      </P
4475 ></LI
4476 ><LI
4477 ><P
4478 >&#13;                                          <CODE
4479 CLASS="parameter"
4480 >name</CODE
4481 >
4482 : string, Slice attribute type name                                     </P
4483 ></LI
4484 ><LI
4485 ><P
4486 >&#13;                                          <CODE
4487 CLASS="parameter"
4488 >description</CODE
4489 >
4490 : string, Slice attribute type description                                      </P
4491 ></LI
4492 ></UL
4493 ></LI
4494 ></UL
4495 ><P
4496 >Returns:</P
4497 ><P
4498 ></P
4499 ><UL
4500 ><LI
4501 ><P
4502 >&#13;int, New attribute_id (&#62; 0) if successful                     </P
4503 ></LI
4504 ></UL
4505 ></DIV
4506 ><DIV
4507 CLASS="section"
4508 ><HR><H2
4509 CLASS="section"
4510 ><A
4511 NAME="AddSliceInstantiation"
4512 >2.28. AddSliceInstantiation</A
4513 ></H2
4514 ><P
4515 >Prototype:<A
4516 NAME="AEN1276"
4517 ></A
4518 ><BLOCKQUOTE
4519 CLASS="BLOCKQUOTE"
4520 ><P
4521 >AddSliceInstantiation (auth, name)</P
4522 ></BLOCKQUOTE
4523 ></P
4524 ><P
4525 >Description:<A
4526 NAME="AEN1279"
4527 ></A
4528 ><BLOCKQUOTE
4529 CLASS="BLOCKQUOTE"
4530 ><P
4531 >Adds a new slice instantiation state.</P
4532 ><P
4533 >Returns 1 if successful, faults otherwise.</P
4534 ></BLOCKQUOTE
4535 ></P
4536 ><P
4537 >Allowed Roles:<A
4538 NAME="AEN1283"
4539 ></A
4540 ><BLOCKQUOTE
4541 CLASS="BLOCKQUOTE"
4542 ><P
4543 >admin</P
4544 ></BLOCKQUOTE
4545 ></P
4546 ><P
4547 >Parameters:</P
4548 ><P
4549 ></P
4550 ><UL
4551 ><LI
4552 ><P
4553 >&#13;                          <CODE
4554 CLASS="parameter"
4555 >auth</CODE
4556 >
4557 : struct, API authentication structure                  </P
4558 ><P
4559 ></P
4560 ><UL
4561 ><LI
4562 ><P
4563 >&#13;                                          <CODE
4564 CLASS="parameter"
4565 >AuthMethod</CODE
4566 >
4567 : string, Authentication method to use                                  </P
4568 ></LI
4569 ></UL
4570 ></LI
4571 ><LI
4572 ><P
4573 >&#13;                          <CODE
4574 CLASS="parameter"
4575 >name</CODE
4576 >
4577 : string, Slice instantiation state                     </P
4578 ></LI
4579 ></UL
4580 ><P
4581 >Returns:</P
4582 ><P
4583 ></P
4584 ><UL
4585 ><LI
4586 ><P
4587 >&#13;int, 1 if successful                      </P
4588 ></LI
4589 ></UL
4590 ></DIV
4591 ><DIV
4592 CLASS="section"
4593 ><HR><H2
4594 CLASS="section"
4595 ><A
4596 NAME="AddSlice"
4597 >2.29. AddSlice</A
4598 ></H2
4599 ><P
4600 >Prototype:<A
4601 NAME="AEN1304"
4602 ></A
4603 ><BLOCKQUOTE
4604 CLASS="BLOCKQUOTE"
4605 ><P
4606 >AddSlice (auth, slice_fields)</P
4607 ></BLOCKQUOTE
4608 ></P
4609 ><P
4610 >Description:<A
4611 NAME="AEN1307"
4612 ></A
4613 ><BLOCKQUOTE
4614 CLASS="BLOCKQUOTE"
4615 ><P
4616 >Adds a new slice. Any fields specified in slice_fields are used,
4617 otherwise defaults are used.</P
4618 ><P
4619 >Valid slice names are lowercase and begin with the login_base
4620 (slice prefix) of a valid site, followed by a single
4621 underscore. Thereafter, only letters, numbers, or additional
4622 underscores may be used.</P
4623 ><P
4624 >PIs may only add slices associated with their own sites (i.e.,
4625 slice prefixes must always be the login_base of one of their
4626 sites).</P
4627 ><P
4628 >Returns the new slice_id (&#62; 0) if successful, faults otherwise.</P
4629 ></BLOCKQUOTE
4630 ></P
4631 ><P
4632 >Allowed Roles:<A
4633 NAME="AEN1313"
4634 ></A
4635 ><BLOCKQUOTE
4636 CLASS="BLOCKQUOTE"
4637 ><P
4638 >admin, pi</P
4639 ></BLOCKQUOTE
4640 ></P
4641 ><P
4642 >Parameters:</P
4643 ><P
4644 ></P
4645 ><UL
4646 ><LI
4647 ><P
4648 >&#13;                          <CODE
4649 CLASS="parameter"
4650 >auth</CODE
4651 >
4652 : struct, API authentication structure                  </P
4653 ><P
4654 ></P
4655 ><UL
4656 ><LI
4657 ><P
4658 >&#13;                                          <CODE
4659 CLASS="parameter"
4660 >AuthMethod</CODE
4661 >
4662 : string, Authentication method to use                                  </P
4663 ></LI
4664 ></UL
4665 ></LI
4666 ><LI
4667 ><P
4668 >&#13;                          <CODE
4669 CLASS="parameter"
4670 >slice_fields</CODE
4671 >
4672 : struct                        </P
4673 ><P
4674 ></P
4675 ><UL
4676 ><LI
4677 ><P
4678 >&#13;                                          <CODE
4679 CLASS="parameter"
4680 >url</CODE
4681 >
4682 : string, URL further describing this slice                                     </P
4683 ></LI
4684 ><LI
4685 ><P
4686 >&#13;                                          <CODE
4687 CLASS="parameter"
4688 >max_nodes</CODE
4689 >
4690 : int, Maximum number of nodes that can be assigned to this slice                                       </P
4691 ></LI
4692 ><LI
4693 ><P
4694 >&#13;                                          <CODE
4695 CLASS="parameter"
4696 >instantiation</CODE
4697 >
4698 : string, Slice instantiation state                                     </P
4699 ></LI
4700 ><LI
4701 ><P
4702 >&#13;                                          <CODE
4703 CLASS="parameter"
4704 >name</CODE
4705 >
4706 : string, Slice name                                    </P
4707 ></LI
4708 ><LI
4709 ><P
4710 >&#13;                                          <CODE
4711 CLASS="parameter"
4712 >description</CODE
4713 >
4714 : string, Slice description                                     </P
4715 ></LI
4716 ></UL
4717 ></LI
4718 ></UL
4719 ><P
4720 >Returns:</P
4721 ><P
4722 ></P
4723 ><UL
4724 ><LI
4725 ><P
4726 >&#13;int, New slice_id (&#62; 0) if successful                 </P
4727 ></LI
4728 ></UL
4729 ></DIV
4730 ><DIV
4731 CLASS="section"
4732 ><HR><H2
4733 CLASS="section"
4734 ><A
4735 NAME="AddSliceToNodes"
4736 >2.30. AddSliceToNodes</A
4737 ></H2
4738 ><P
4739 >Prototype:<A
4740 NAME="AEN1350"
4741 ></A
4742 ><BLOCKQUOTE
4743 CLASS="BLOCKQUOTE"
4744 ><P
4745 >AddSliceToNodes (auth, slice_id_or_name, node_id_or_hostname_list)</P
4746 ></BLOCKQUOTE
4747 ></P
4748 ><P
4749 >Description:<A
4750 NAME="AEN1353"
4751 ></A
4752 ><BLOCKQUOTE
4753 CLASS="BLOCKQUOTE"
4754 ><P
4755 >Adds the specified slice to the specified nodes. Nodes may be
4756 either local or foreign nodes.</P
4757 ><P
4758 >If the slice is already associated with a node, no errors are
4759 returned.</P
4760 ><P
4761 >Returns 1 if successful, faults otherwise.</P
4762 ></BLOCKQUOTE
4763 ></P
4764 ><P
4765 >Allowed Roles:<A
4766 NAME="AEN1358"
4767 ></A
4768 ><BLOCKQUOTE
4769 CLASS="BLOCKQUOTE"
4770 ><P
4771 >admin, pi, user</P
4772 ></BLOCKQUOTE
4773 ></P
4774 ><P
4775 >Parameters:</P
4776 ><P
4777 ></P
4778 ><UL
4779 ><LI
4780 ><P
4781 >&#13;                          <CODE
4782 CLASS="parameter"
4783 >auth</CODE
4784 >
4785 : struct, API authentication structure                  </P
4786 ><P
4787 ></P
4788 ><UL
4789 ><LI
4790 ><P
4791 >&#13;                                          <CODE
4792 CLASS="parameter"
4793 >AuthMethod</CODE
4794 >
4795 : string, Authentication method to use                                  </P
4796 ></LI
4797 ></UL
4798 ></LI
4799 ><LI
4800 ><P
4801 >&#13;                          <CODE
4802 CLASS="parameter"
4803 >slice_id_or_name</CODE
4804 >
4805 : int or string                 </P
4806 ><P
4807 ></P
4808 ><UL
4809 ><LI
4810 ><P
4811 >&#13;int, Slice identifier                                     </P
4812 ></LI
4813 ><LI
4814 ><P
4815 >&#13;string, Slice name                                        </P
4816 ></LI
4817 ></UL
4818 ></LI
4819 ><LI
4820 ><P
4821 >&#13;                          <CODE
4822 CLASS="parameter"
4823 >node_id_or_hostname_list</CODE
4824 >
4825 : array of int or string                        </P
4826 ><P
4827 ></P
4828 ><UL
4829 ><LI
4830 ><P
4831 >&#13;int, Node identifier                                      </P
4832 ></LI
4833 ><LI
4834 ><P
4835 >&#13;string, Fully qualified hostname                                  </P
4836 ></LI
4837 ></UL
4838 ></LI
4839 ></UL
4840 ><P
4841 >Returns:</P
4842 ><P
4843 ></P
4844 ><UL
4845 ><LI
4846 ><P
4847 >&#13;int, 1 if successful                      </P
4848 ></LI
4849 ></UL
4850 ></DIV
4851 ><DIV
4852 CLASS="section"
4853 ><HR><H2
4854 CLASS="section"
4855 ><A
4856 NAME="AuthCheck"
4857 >2.31. AuthCheck</A
4858 ></H2
4859 ><P
4860 >Prototype:<A
4861 NAME="AEN1392"
4862 ></A
4863 ><BLOCKQUOTE
4864 CLASS="BLOCKQUOTE"
4865 ><P
4866 >AuthCheck (auth)</P
4867 ></BLOCKQUOTE
4868 ></P
4869 ><P
4870 >Description:<A
4871 NAME="AEN1395"
4872 ></A
4873 ><BLOCKQUOTE
4874 CLASS="BLOCKQUOTE"
4875 ><P
4876 >Returns 1 if the user or node authenticated successfully, faults
4877 otherwise.</P
4878 ></BLOCKQUOTE
4879 ></P
4880 ><P
4881 >Allowed Roles:<A
4882 NAME="AEN1398"
4883 ></A
4884 ><BLOCKQUOTE
4885 CLASS="BLOCKQUOTE"
4886 ><P
4887 >admin, pi, user, tech, node</P
4888 ></BLOCKQUOTE
4889 ></P
4890 ><P
4891 >Parameters:</P
4892 ><P
4893 ></P
4894 ><UL
4895 ><LI
4896 ><P
4897 >&#13;                          <CODE
4898 CLASS="parameter"
4899 >auth</CODE
4900 >
4901 : struct, API authentication structure                  </P
4902 ><P
4903 ></P
4904 ><UL
4905 ><LI
4906 ><P
4907 >&#13;                                          <CODE
4908 CLASS="parameter"
4909 >AuthMethod</CODE
4910 >
4911 : string, Authentication method to use                                  </P
4912 ></LI
4913 ></UL
4914 ></LI
4915 ></UL
4916 ><P
4917 >Returns:</P
4918 ><P
4919 ></P
4920 ><UL
4921 ><LI
4922 ><P
4923 >&#13;int, 1 if successful                      </P
4924 ></LI
4925 ></UL
4926 ></DIV
4927 ><DIV
4928 CLASS="section"
4929 ><HR><H2
4930 CLASS="section"
4931 ><A
4932 NAME="BlacklistKey"
4933 >2.32. BlacklistKey</A
4934 ></H2
4935 ><P
4936 >Prototype:<A
4937 NAME="AEN1416"
4938 ></A
4939 ><BLOCKQUOTE
4940 CLASS="BLOCKQUOTE"
4941 ><P
4942 >BlacklistKey (auth, key_id)</P
4943 ></BLOCKQUOTE
4944 ></P
4945 ><P
4946 >Description:<A
4947 NAME="AEN1419"
4948 ></A
4949 ><BLOCKQUOTE
4950 CLASS="BLOCKQUOTE"
4951 ><P
4952 >Blacklists a key, disassociating it and all others identical to it
4953 from all accounts and preventing it from ever being added again.</P
4954 ><P
4955 >WARNING: Identical keys associated with other accounts with also
4956 be blacklisted.</P
4957 ><P
4958 >Returns 1 if successful, faults otherwise.</P
4959 ></BLOCKQUOTE
4960 ></P
4961 ><P
4962 >Allowed Roles:<A
4963 NAME="AEN1424"
4964 ></A
4965 ><BLOCKQUOTE
4966 CLASS="BLOCKQUOTE"
4967 ><P
4968 >admin</P
4969 ></BLOCKQUOTE
4970 ></P
4971 ><P
4972 >Parameters:</P
4973 ><P
4974 ></P
4975 ><UL
4976 ><LI
4977 ><P
4978 >&#13;                          <CODE
4979 CLASS="parameter"
4980 >auth</CODE
4981 >
4982 : struct, API authentication structure                  </P
4983 ><P
4984 ></P
4985 ><UL
4986 ><LI
4987 ><P
4988 >&#13;                                          <CODE
4989 CLASS="parameter"
4990 >AuthMethod</CODE
4991 >
4992 : string, Authentication method to use                                  </P
4993 ></LI
4994 ></UL
4995 ></LI
4996 ><LI
4997 ><P
4998 >&#13;                          <CODE
4999 CLASS="parameter"
5000 >key_id</CODE
5001 >
5002 : int, Key identifier                   </P
5003 ></LI
5004 ></UL
5005 ><P
5006 >Returns:</P
5007 ><P
5008 ></P
5009 ><UL
5010 ><LI
5011 ><P
5012 >&#13;int, 1 if successful                      </P
5013 ></LI
5014 ></UL
5015 ></DIV
5016 ><DIV
5017 CLASS="section"
5018 ><HR><H2
5019 CLASS="section"
5020 ><A
5021 NAME="BootGetNodeDetails"
5022 >2.33. BootGetNodeDetails</A
5023 ></H2
5024 ><P
5025 >Prototype:<A
5026 NAME="AEN1445"
5027 ></A
5028 ><BLOCKQUOTE
5029 CLASS="BLOCKQUOTE"
5030 ><P
5031 >BootGetNodeDetails (auth)</P
5032 ></BLOCKQUOTE
5033 ></P
5034 ><P
5035 >Description:<A
5036 NAME="AEN1448"
5037 ></A
5038 ><BLOCKQUOTE
5039 CLASS="BLOCKQUOTE"
5040 ><P
5041 >Returns a set of details about the calling node, including a new
5042 node session value.</P
5043 ></BLOCKQUOTE
5044 ></P
5045 ><P
5046 >Allowed Roles:<A
5047 NAME="AEN1451"
5048 ></A
5049 ><BLOCKQUOTE
5050 CLASS="BLOCKQUOTE"
5051 ><P
5052 >node</P
5053 ></BLOCKQUOTE
5054 ></P
5055 ><P
5056 >Parameters:</P
5057 ><P
5058 ></P
5059 ><UL
5060 ><LI
5061 ><P
5062 >&#13;                          <CODE
5063 CLASS="parameter"
5064 >auth</CODE
5065 >
5066 : struct, API authentication structure                  </P
5067 ><P
5068 ></P
5069 ><UL
5070 ><LI
5071 ><P
5072 >&#13;                                          <CODE
5073 CLASS="parameter"
5074 >AuthMethod</CODE
5075 >
5076 : string, Authentication method to use, always 'hmac'                                   </P
5077 ></LI
5078 ><LI
5079 ><P
5080 >&#13;                                          <CODE
5081 CLASS="parameter"
5082 >value</CODE
5083 >
5084 : string, HMAC of node key and method call                                      </P
5085 ></LI
5086 ><LI
5087 ><P
5088 >&#13;                                          <CODE
5089 CLASS="parameter"
5090 >node_id</CODE
5091 >
5092 : int, Node identifier                                  </P
5093 ></LI
5094 ></UL
5095 ></LI
5096 ></UL
5097 ><P
5098 >Returns:</P
5099 ><P
5100 ></P
5101 ><UL
5102 ><LI
5103 ><P
5104 >&#13;struct                    </P
5105 ><P
5106 ></P
5107 ><UL
5108 ><LI
5109 ><P
5110 >&#13;                                          <CODE
5111 CLASS="parameter"
5112 >boot_state</CODE
5113 >
5114 : string, Boot state                                    </P
5115 ></LI
5116 ><LI
5117 ><P
5118 >&#13;                                          <CODE
5119 CLASS="parameter"
5120 >model</CODE
5121 >
5122 : string, Make and model of the actual machine                                  </P
5123 ></LI
5124 ><LI
5125 ><P
5126 >&#13;                                          <CODE
5127 CLASS="parameter"
5128 >hostname</CODE
5129 >
5130 : string, Fully qualified hostname                                      </P
5131 ></LI
5132 ><LI
5133 ><P
5134 >&#13;                                          <CODE
5135 CLASS="parameter"
5136 >networks</CODE
5137 >
5138 : array of struct                                       </P
5139 ><P
5140 ></P
5141 ><UL
5142 ><LI
5143 ><P
5144 >&#13;                                                          <CODE
5145 CLASS="parameter"
5146 >broadcast</CODE
5147 >
5148 : string, Network broadcast address                                                     </P
5149 ></LI
5150 ><LI
5151 ><P
5152 >&#13;                                                          <CODE
5153 CLASS="parameter"
5154 >is_primary</CODE
5155 >
5156 : boolean, Is the primary interface for this node                                                       </P
5157 ></LI
5158 ><LI
5159 ><P
5160 >&#13;                                                          <CODE
5161 CLASS="parameter"
5162 >network</CODE
5163 >
5164 : string, Subnet address                                                        </P
5165 ></LI
5166 ><LI
5167 ><P
5168 >&#13;                                                          <CODE
5169 CLASS="parameter"
5170 >ip</CODE
5171 >
5172 : string, IP address                                                    </P
5173 ></LI
5174 ><LI
5175 ><P
5176 >&#13;                                                          <CODE
5177 CLASS="parameter"
5178 >dns1</CODE
5179 >
5180 : string, IP address of primary DNS server                                                      </P
5181 ></LI
5182 ><LI
5183 ><P
5184 >&#13;                                                          <CODE
5185 CLASS="parameter"
5186 >hostname</CODE
5187 >
5188 : string, (Optional) Hostname                                                   </P
5189 ></LI
5190 ><LI
5191 ><P
5192 >&#13;                                                          <CODE
5193 CLASS="parameter"
5194 >netmask</CODE
5195 >
5196 : string, Subnet mask                                                   </P
5197 ></LI
5198 ><LI
5199 ><P
5200 >&#13;                                                          <CODE
5201 CLASS="parameter"
5202 >gateway</CODE
5203 >
5204 : string, IP address of primary gateway                                                 </P
5205 ></LI
5206 ><LI
5207 ><P
5208 >&#13;                                                          <CODE
5209 CLASS="parameter"
5210 >nodenetwork_id</CODE
5211 >
5212 : int, Node interface identifier                                                        </P
5213 ></LI
5214 ><LI
5215 ><P
5216 >&#13;                                                          <CODE
5217 CLASS="parameter"
5218 >mac</CODE
5219 >
5220 : string, MAC address                                                   </P
5221 ></LI
5222 ><LI
5223 ><P
5224 >&#13;                                                          <CODE
5225 CLASS="parameter"
5226 >node_id</CODE
5227 >
5228 : int, Node associated with this interface                                                      </P
5229 ></LI
5230 ><LI
5231 ><P
5232 >&#13;                                                          <CODE
5233 CLASS="parameter"
5234 >dns2</CODE
5235 >
5236 : string, IP address of secondary DNS server                                                    </P
5237 ></LI
5238 ><LI
5239 ><P
5240 >&#13;                                                          <CODE
5241 CLASS="parameter"
5242 >bwlimit</CODE
5243 >
5244 : int, Bandwidth limit                                                  </P
5245 ></LI
5246 ><LI
5247 ><P
5248 >&#13;                                                          <CODE
5249 CLASS="parameter"
5250 >type</CODE
5251 >
5252 : string, Address type (e.g., 'ipv4')                                                   </P
5253 ></LI
5254 ><LI
5255 ><P
5256 >&#13;                                                          <CODE
5257 CLASS="parameter"
5258 >method</CODE
5259 >
5260 : string, Addressing method (e.g., 'static' or 'dhcp')                                                  </P
5261 ></LI
5262 ></UL
5263 ></LI
5264 ><LI
5265 ><P
5266 >&#13;                                          <CODE
5267 CLASS="parameter"
5268 >session</CODE
5269 >
5270 : string, Session key                                   </P
5271 ></LI
5272 ></UL
5273 ></LI
5274 ></UL
5275 ></DIV
5276 ><DIV
5277 CLASS="section"
5278 ><HR><H2
5279 CLASS="section"
5280 ><A
5281 NAME="BootNotifyOwners"
5282 >2.34. BootNotifyOwners</A
5283 ></H2
5284 ><P
5285 >Prototype:<A
5286 NAME="AEN1537"
5287 ></A
5288 ><BLOCKQUOTE
5289 CLASS="BLOCKQUOTE"
5290 ><P
5291 >BootNotifyOwners (auth, message_id, include_pis, include_techs, include_support)</P
5292 ></BLOCKQUOTE
5293 ></P
5294 ><P
5295 >Description:<A
5296 NAME="AEN1540"
5297 ></A
5298 ><BLOCKQUOTE
5299 CLASS="BLOCKQUOTE"
5300 ><P
5301 >Notify the owners of the node, and/or support about an event that
5302 happened on the machine.</P
5303 ><P
5304 >Returns 1 if successful.</P
5305 ></BLOCKQUOTE
5306 ></P
5307 ><P
5308 >Allowed Roles:<A
5309 NAME="AEN1544"
5310 ></A
5311 ><BLOCKQUOTE
5312 CLASS="BLOCKQUOTE"
5313 ><P
5314 >node</P
5315 ></BLOCKQUOTE
5316 ></P
5317 ><P
5318 >Parameters:</P
5319 ><P
5320 ></P
5321 ><UL
5322 ><LI
5323 ><P
5324 >&#13;                          <CODE
5325 CLASS="parameter"
5326 >auth</CODE
5327 >
5328 : struct, API authentication structure                  </P
5329 ><P
5330 ></P
5331 ><UL
5332 ><LI
5333 ><P
5334 >&#13;                                          <CODE
5335 CLASS="parameter"
5336 >AuthMethod</CODE
5337 >
5338 : string, Authentication method to use, always 'hmac'                                   </P
5339 ></LI
5340 ><LI
5341 ><P
5342 >&#13;                                          <CODE
5343 CLASS="parameter"
5344 >value</CODE
5345 >
5346 : string, HMAC of node key and method call                                      </P
5347 ></LI
5348 ><LI
5349 ><P
5350 >&#13;                                          <CODE
5351 CLASS="parameter"
5352 >node_id</CODE
5353 >
5354 : int, Node identifier                                  </P
5355 ></LI
5356 ></UL
5357 ></LI
5358 ><LI
5359 ><P
5360 >&#13;                          <CODE
5361 CLASS="parameter"
5362 >message_id</CODE
5363 >
5364 : string, Message identifier                    </P
5365 ></LI
5366 ><LI
5367 ><P
5368 >&#13;                          <CODE
5369 CLASS="parameter"
5370 >include_pis</CODE
5371 >
5372 : int, Notify PIs                       </P
5373 ></LI
5374 ><LI
5375 ><P
5376 >&#13;                          <CODE
5377 CLASS="parameter"
5378 >include_techs</CODE
5379 >
5380 : int, Notify technical contacts                        </P
5381 ></LI
5382 ><LI
5383 ><P
5384 >&#13;                          <CODE
5385 CLASS="parameter"
5386 >include_support</CODE
5387 >
5388 : int, Notify support                   </P
5389 ></LI
5390 ></UL
5391 ><P
5392 >Returns:</P
5393 ><P
5394 ></P
5395 ><UL
5396 ><LI
5397 ><P
5398 >&#13;int, 1 if successful                      </P
5399 ></LI
5400 ></UL
5401 ></DIV
5402 ><DIV
5403 CLASS="section"
5404 ><HR><H2
5405 CLASS="section"
5406 ><A
5407 NAME="BootUpdateNode"
5408 >2.35. BootUpdateNode</A
5409 ></H2
5410 ><P
5411 >Prototype:<A
5412 NAME="AEN1580"
5413 ></A
5414 ><BLOCKQUOTE
5415 CLASS="BLOCKQUOTE"
5416 ><P
5417 >BootUpdateNode (auth, node_fields)</P
5418 ></BLOCKQUOTE
5419 ></P
5420 ><P
5421 >Description:<A
5422 NAME="AEN1583"
5423 ></A
5424 ><BLOCKQUOTE
5425 CLASS="BLOCKQUOTE"
5426 ><P
5427 >Allows the calling node to update its own record. Only the primary
5428 network can be updated, and the node IP cannot be changed.</P
5429 ><P
5430 >Returns 1 if updated successfully.</P
5431 ></BLOCKQUOTE
5432 ></P
5433 ><P
5434 >Allowed Roles:<A
5435 NAME="AEN1587"
5436 ></A
5437 ><BLOCKQUOTE
5438 CLASS="BLOCKQUOTE"
5439 ><P
5440 >node</P
5441 ></BLOCKQUOTE
5442 ></P
5443 ><P
5444 >Parameters:</P
5445 ><P
5446 ></P
5447 ><UL
5448 ><LI
5449 ><P
5450 >&#13;                          <CODE
5451 CLASS="parameter"
5452 >auth</CODE
5453 >
5454 : struct, API authentication structure                  </P
5455 ><P
5456 ></P
5457 ><UL
5458 ><LI
5459 ><P
5460 >&#13;                                          <CODE
5461 CLASS="parameter"
5462 >AuthMethod</CODE
5463 >
5464 : string, Authentication method to use, always 'hmac'                                   </P
5465 ></LI
5466 ><LI
5467 ><P
5468 >&#13;                                          <CODE
5469 CLASS="parameter"
5470 >value</CODE
5471 >
5472 : string, HMAC of node key and method call                                      </P
5473 ></LI
5474 ><LI
5475 ><P
5476 >&#13;                                          <CODE
5477 CLASS="parameter"
5478 >node_id</CODE
5479 >
5480 : int, Node identifier                                  </P
5481 ></LI
5482 ></UL
5483 ></LI
5484 ><LI
5485 ><P
5486 >&#13;                          <CODE
5487 CLASS="parameter"
5488 >node_fields</CODE
5489 >
5490 : struct                        </P
5491 ><P
5492 ></P
5493 ><UL
5494 ><LI
5495 ><P
5496 >&#13;                                          <CODE
5497 CLASS="parameter"
5498 >boot_state</CODE
5499 >
5500 : string, Boot state                                    </P
5501 ></LI
5502 ><LI
5503 ><P
5504 >&#13;                                          <CODE
5505 CLASS="parameter"
5506 >primary_network</CODE
5507 >
5508 : struct                                        </P
5509 ><P
5510 ></P
5511 ><UL
5512 ><LI
5513 ><P
5514 >&#13;                                                          <CODE
5515 CLASS="parameter"
5516 >network</CODE
5517 >
5518 : string, Subnet address                                                        </P
5519 ></LI
5520 ><LI
5521 ><P
5522 >&#13;                                                          <CODE
5523 CLASS="parameter"
5524 >dns2</CODE
5525 >
5526 : string, IP address of secondary DNS server                                                    </P
5527 ></LI
5528 ><LI
5529 ><P
5530 >&#13;                                                          <CODE
5531 CLASS="parameter"
5532 >dns1</CODE
5533 >
5534 : string, IP address of primary DNS server                                                      </P
5535 ></LI
5536 ><LI
5537 ><P
5538 >&#13;                                                          <CODE
5539 CLASS="parameter"
5540 >netmask</CODE
5541 >
5542 : string, Subnet mask                                                   </P
5543 ></LI
5544 ><LI
5545 ><P
5546 >&#13;                                                          <CODE
5547 CLASS="parameter"
5548 >method</CODE
5549 >
5550 : string, Addressing method (e.g., 'static' or 'dhcp')                                                  </P
5551 ></LI
5552 ><LI
5553 ><P
5554 >&#13;                                                          <CODE
5555 CLASS="parameter"
5556 >broadcast</CODE
5557 >
5558 : string, Network broadcast address                                                     </P
5559 ></LI
5560 ><LI
5561 ><P
5562 >&#13;                                                          <CODE
5563 CLASS="parameter"
5564 >mac</CODE
5565 >
5566 : string, MAC address                                                   </P
5567 ></LI
5568 ><LI
5569 ><P
5570 >&#13;                                                          <CODE
5571 CLASS="parameter"
5572 >gateway</CODE
5573 >
5574 : string, IP address of primary gateway                                                 </P
5575 ></LI
5576 ></UL
5577 ></LI
5578 ><LI
5579 ><P
5580 >&#13;                                          <CODE
5581 CLASS="parameter"
5582 >ssh_host_key</CODE
5583 >
5584 : string, Last known SSH host key                                       </P
5585 ></LI
5586 ></UL
5587 ></LI
5588 ></UL
5589 ><P
5590 >Returns:</P
5591 ><P
5592 ></P
5593 ><UL
5594 ><LI
5595 ><P
5596 >&#13;int, 1 if successful                      </P
5597 ></LI
5598 ></UL
5599 ></DIV
5600 ><DIV
5601 CLASS="section"
5602 ><HR><H2
5603 CLASS="section"
5604 ><A
5605 NAME="DeleteAddress"
5606 >2.36. DeleteAddress</A
5607 ></H2
5608 ><P
5609 >Prototype:<A
5610 NAME="AEN1649"
5611 ></A
5612 ><BLOCKQUOTE
5613 CLASS="BLOCKQUOTE"
5614 ><P
5615 >DeleteAddress (auth, address_id)</P
5616 ></BLOCKQUOTE
5617 ></P
5618 ><P
5619 >Description:<A
5620 NAME="AEN1652"
5621 ></A
5622 ><BLOCKQUOTE
5623 CLASS="BLOCKQUOTE"
5624 ><P
5625 >Deletes an address.</P
5626 ><P
5627 >PIs may only delete addresses from their own sites.</P
5628 ><P
5629 >Returns 1 if successful, faults otherwise.</P
5630 ></BLOCKQUOTE
5631 ></P
5632 ><P
5633 >Allowed Roles:<A
5634 NAME="AEN1657"
5635 ></A
5636 ><BLOCKQUOTE
5637 CLASS="BLOCKQUOTE"
5638 ><P
5639 >admin, pi</P
5640 ></BLOCKQUOTE
5641 ></P
5642 ><P
5643 >Parameters:</P
5644 ><P
5645 ></P
5646 ><UL
5647 ><LI
5648 ><P
5649 >&#13;                          <CODE
5650 CLASS="parameter"
5651 >auth</CODE
5652 >
5653 : struct, API authentication structure                  </P
5654 ><P
5655 ></P
5656 ><UL
5657 ><LI
5658 ><P
5659 >&#13;                                          <CODE
5660 CLASS="parameter"
5661 >AuthMethod</CODE
5662 >
5663 : string, Authentication method to use                                  </P
5664 ></LI
5665 ></UL
5666 ></LI
5667 ><LI
5668 ><P
5669 >&#13;                          <CODE
5670 CLASS="parameter"
5671 >address_id</CODE
5672 >
5673 : int, Address identifier                       </P
5674 ></LI
5675 ></UL
5676 ><P
5677 >Returns:</P
5678 ><P
5679 ></P
5680 ><UL
5681 ><LI
5682 ><P
5683 >&#13;int, 1 if successful                      </P
5684 ></LI
5685 ></UL
5686 ></DIV
5687 ><DIV
5688 CLASS="section"
5689 ><HR><H2
5690 CLASS="section"
5691 ><A
5692 NAME="DeleteAddressTypeFromAddress"
5693 >2.37. DeleteAddressTypeFromAddress</A
5694 ></H2
5695 ><P
5696 >Prototype:<A
5697 NAME="AEN1678"
5698 ></A
5699 ><BLOCKQUOTE
5700 CLASS="BLOCKQUOTE"
5701 ><P
5702 >DeleteAddressTypeFromAddress (auth, address_type_id_or_name, address_id)</P
5703 ></BLOCKQUOTE
5704 ></P
5705 ><P
5706 >Description:<A
5707 NAME="AEN1681"
5708 ></A
5709 ><BLOCKQUOTE
5710 CLASS="BLOCKQUOTE"
5711 ><P
5712 >Deletes an address type from the specified address.</P
5713 ><P
5714 >PIs may only update addresses of their own sites.</P
5715 ><P
5716 >Returns 1 if successful, faults otherwise.</P
5717 ></BLOCKQUOTE
5718 ></P
5719 ><P
5720 >Allowed Roles:<A
5721 NAME="AEN1686"
5722 ></A
5723 ><BLOCKQUOTE
5724 CLASS="BLOCKQUOTE"
5725 ><P
5726 >admin, pi</P
5727 ></BLOCKQUOTE
5728 ></P
5729 ><P
5730 >Parameters:</P
5731 ><P
5732 ></P
5733 ><UL
5734 ><LI
5735 ><P
5736 >&#13;                          <CODE
5737 CLASS="parameter"
5738 >auth</CODE
5739 >
5740 : struct, API authentication structure                  </P
5741 ><P
5742 ></P
5743 ><UL
5744 ><LI
5745 ><P
5746 >&#13;                                          <CODE
5747 CLASS="parameter"
5748 >AuthMethod</CODE
5749 >
5750 : string, Authentication method to use                                  </P
5751 ></LI
5752 ></UL
5753 ></LI
5754 ><LI
5755 ><P
5756 >&#13;                          <CODE
5757 CLASS="parameter"
5758 >address_type_id_or_name</CODE
5759 >
5760 : int or string                 </P
5761 ><P
5762 ></P
5763 ><UL
5764 ><LI
5765 ><P
5766 >&#13;int, Address type identifier                                      </P
5767 ></LI
5768 ><LI
5769 ><P
5770 >&#13;string, Address type                                      </P
5771 ></LI
5772 ></UL
5773 ></LI
5774 ><LI
5775 ><P
5776 >&#13;                          <CODE
5777 CLASS="parameter"
5778 >address_id</CODE
5779 >
5780 : int, Address identifier                       </P
5781 ></LI
5782 ></UL
5783 ><P
5784 >Returns:</P
5785 ><P
5786 ></P
5787 ><UL
5788 ><LI
5789 ><P
5790 >&#13;int, 1 if successful                      </P
5791 ></LI
5792 ></UL
5793 ></DIV
5794 ><DIV
5795 CLASS="section"
5796 ><HR><H2
5797 CLASS="section"
5798 ><A
5799 NAME="DeleteAddressType"
5800 >2.38. DeleteAddressType</A
5801 ></H2
5802 ><P
5803 >Prototype:<A
5804 NAME="AEN1715"
5805 ></A
5806 ><BLOCKQUOTE
5807 CLASS="BLOCKQUOTE"
5808 ><P
5809 >DeleteAddressType (auth, address_type_id_or_name)</P
5810 ></BLOCKQUOTE
5811 ></P
5812 ><P
5813 >Description:<A
5814 NAME="AEN1718"
5815 ></A
5816 ><BLOCKQUOTE
5817 CLASS="BLOCKQUOTE"
5818 ><P
5819 >Deletes an address type.</P
5820 ><P
5821 >Returns 1 if successful, faults otherwise.</P
5822 ></BLOCKQUOTE
5823 ></P
5824 ><P
5825 >Allowed Roles:<A
5826 NAME="AEN1722"
5827 ></A
5828 ><BLOCKQUOTE
5829 CLASS="BLOCKQUOTE"
5830 ><P
5831 >admin</P
5832 ></BLOCKQUOTE
5833 ></P
5834 ><P
5835 >Parameters:</P
5836 ><P
5837 ></P
5838 ><UL
5839 ><LI
5840 ><P
5841 >&#13;                          <CODE
5842 CLASS="parameter"
5843 >auth</CODE
5844 >
5845 : struct, API authentication structure                  </P
5846 ><P
5847 ></P
5848 ><UL
5849 ><LI
5850 ><P
5851 >&#13;                                          <CODE
5852 CLASS="parameter"
5853 >AuthMethod</CODE
5854 >
5855 : string, Authentication method to use                                  </P
5856 ></LI
5857 ></UL
5858 ></LI
5859 ><LI
5860 ><P
5861 >&#13;                          <CODE
5862 CLASS="parameter"
5863 >address_type_id_or_name</CODE
5864 >
5865 : int or string                 </P
5866 ><P
5867 ></P
5868 ><UL
5869 ><LI
5870 ><P
5871 >&#13;int, Address type identifier                                      </P
5872 ></LI
5873 ><LI
5874 ><P
5875 >&#13;string, Address type                                      </P
5876 ></LI
5877 ></UL
5878 ></LI
5879 ></UL
5880 ><P
5881 >Returns:</P
5882 ><P
5883 ></P
5884 ><UL
5885 ><LI
5886 ><P
5887 >&#13;int, 1 if successful                      </P
5888 ></LI
5889 ></UL
5890 ></DIV
5891 ><DIV
5892 CLASS="section"
5893 ><HR><H2
5894 CLASS="section"
5895 ><A
5896 NAME="DeleteBootState"
5897 >2.39. DeleteBootState</A
5898 ></H2
5899 ><P
5900 >Prototype:<A
5901 NAME="AEN1748"
5902 ></A
5903 ><BLOCKQUOTE
5904 CLASS="BLOCKQUOTE"
5905 ><P
5906 >DeleteBootState (auth, name)</P
5907 ></BLOCKQUOTE
5908 ></P
5909 ><P
5910 >Description:<A
5911 NAME="AEN1751"
5912 ></A
5913 ><BLOCKQUOTE
5914 CLASS="BLOCKQUOTE"
5915 ><P
5916 >Deletes a node boot state.</P
5917 ><P
5918 >WARNING: This will cause the deletion of all nodes in this boot
5919 state.</P
5920 ><P
5921 >Returns 1 if successful, faults otherwise.</P
5922 ></BLOCKQUOTE
5923 ></P
5924 ><P
5925 >Allowed Roles:<A
5926 NAME="AEN1756"
5927 ></A
5928 ><BLOCKQUOTE
5929 CLASS="BLOCKQUOTE"
5930 ><P
5931 >admin</P
5932 ></BLOCKQUOTE
5933 ></P
5934 ><P
5935 >Parameters:</P
5936 ><P
5937 ></P
5938 ><UL
5939 ><LI
5940 ><P
5941 >&#13;                          <CODE
5942 CLASS="parameter"
5943 >auth</CODE
5944 >
5945 : struct, API authentication structure                  </P
5946 ><P
5947 ></P
5948 ><UL
5949 ><LI
5950 ><P
5951 >&#13;                                          <CODE
5952 CLASS="parameter"
5953 >AuthMethod</CODE
5954 >
5955 : string, Authentication method to use                                  </P
5956 ></LI
5957 ></UL
5958 ></LI
5959 ><LI
5960 ><P
5961 >&#13;                          <CODE
5962 CLASS="parameter"
5963 >name</CODE
5964 >
5965 : string, Boot state                    </P
5966 ></LI
5967 ></UL
5968 ><P
5969 >Returns:</P
5970 ><P
5971 ></P
5972 ><UL
5973 ><LI
5974 ><P
5975 >&#13;int, 1 if successful                      </P
5976 ></LI
5977 ></UL
5978 ></DIV
5979 ><DIV
5980 CLASS="section"
5981 ><HR><H2
5982 CLASS="section"
5983 ><A
5984 NAME="DeleteConfFileFromNodeGroup"
5985 >2.40. DeleteConfFileFromNodeGroup</A
5986 ></H2
5987 ><P
5988 >Prototype:<A
5989 NAME="AEN1777"
5990 ></A
5991 ><BLOCKQUOTE
5992 CLASS="BLOCKQUOTE"
5993 ><P
5994 >DeleteConfFileFromNodeGroup (auth, conf_file_id, nodegroup_id_or_name)</P
5995 ></BLOCKQUOTE
5996 ></P
5997 ><P
5998 >Description:<A
5999 NAME="AEN1780"
6000 ></A
6001 ><BLOCKQUOTE
6002 CLASS="BLOCKQUOTE"
6003 ><P
6004 >Deletes a configuration file from the specified nodegroup. If the nodegroup
6005 is not linked to the configuration file, no errors are returned.</P
6006 ><P
6007 >Returns 1 if successful, faults otherwise.</P
6008 ></BLOCKQUOTE
6009 ></P
6010 ><P
6011 >Allowed Roles:<A
6012 NAME="AEN1784"
6013 ></A
6014 ><BLOCKQUOTE
6015 CLASS="BLOCKQUOTE"
6016 ><P
6017 >admin</P
6018 ></BLOCKQUOTE
6019 ></P
6020 ><P
6021 >Parameters:</P
6022 ><P
6023 ></P
6024 ><UL
6025 ><LI
6026 ><P
6027 >&#13;                          <CODE
6028 CLASS="parameter"
6029 >auth</CODE
6030 >
6031 : struct, API authentication structure                  </P
6032 ><P
6033 ></P
6034 ><UL
6035 ><LI
6036 ><P
6037 >&#13;                                          <CODE
6038 CLASS="parameter"
6039 >AuthMethod</CODE
6040 >
6041 : string, Authentication method to use                                  </P
6042 ></LI
6043 ></UL
6044 ></LI
6045 ><LI
6046 ><P
6047 >&#13;                          <CODE
6048 CLASS="parameter"
6049 >conf_file_id</CODE
6050 >
6051 : int, Configuration file identifier                    </P
6052 ></LI
6053 ><LI
6054 ><P
6055 >&#13;                          <CODE
6056 CLASS="parameter"
6057 >nodegroup_id_or_name</CODE
6058 >
6059 : int or string                 </P
6060 ><P
6061 ></P
6062 ><UL
6063 ><LI
6064 ><P
6065 >&#13;int, Node group identifier                                        </P
6066 ></LI
6067 ><LI
6068 ><P
6069 >&#13;string, Node group name                                   </P
6070 ></LI
6071 ></UL
6072 ></LI
6073 ></UL
6074 ><P
6075 >Returns:</P
6076 ><P
6077 ></P
6078 ><UL
6079 ><LI
6080 ><P
6081 >&#13;int, 1 if successful                      </P
6082 ></LI
6083 ></UL
6084 ></DIV
6085 ><DIV
6086 CLASS="section"
6087 ><HR><H2
6088 CLASS="section"
6089 ><A
6090 NAME="DeleteConfFileFromNode"
6091 >2.41. DeleteConfFileFromNode</A
6092 ></H2
6093 ><P
6094 >Prototype:<A
6095 NAME="AEN1813"
6096 ></A
6097 ><BLOCKQUOTE
6098 CLASS="BLOCKQUOTE"
6099 ><P
6100 >DeleteConfFileFromNode (auth, conf_file_id, node_id_or_hostname)</P
6101 ></BLOCKQUOTE
6102 ></P
6103 ><P
6104 >Description:<A
6105 NAME="AEN1816"
6106 ></A
6107 ><BLOCKQUOTE
6108 CLASS="BLOCKQUOTE"
6109 ><P
6110 >Deletes a configuration file from the specified node. If the node
6111 is not linked to the configuration file, no errors are returned.</P
6112 ><P
6113 >Returns 1 if successful, faults otherwise.</P
6114 ></BLOCKQUOTE
6115 ></P
6116 ><P
6117 >Allowed Roles:<A
6118 NAME="AEN1820"
6119 ></A
6120 ><BLOCKQUOTE
6121 CLASS="BLOCKQUOTE"
6122 ><P
6123 >admin</P
6124 ></BLOCKQUOTE
6125 ></P
6126 ><P
6127 >Parameters:</P
6128 ><P
6129 ></P
6130 ><UL
6131 ><LI
6132 ><P
6133 >&#13;                          <CODE
6134 CLASS="parameter"
6135 >auth</CODE
6136 >
6137 : struct, API authentication structure                  </P
6138 ><P
6139 ></P
6140 ><UL
6141 ><LI
6142 ><P
6143 >&#13;                                          <CODE
6144 CLASS="parameter"
6145 >AuthMethod</CODE
6146 >
6147 : string, Authentication method to use                                  </P
6148 ></LI
6149 ></UL
6150 ></LI
6151 ><LI
6152 ><P
6153 >&#13;                          <CODE
6154 CLASS="parameter"
6155 >conf_file_id</CODE
6156 >
6157 : int, Configuration file identifier                    </P
6158 ></LI
6159 ><LI
6160 ><P
6161 >&#13;                          <CODE
6162 CLASS="parameter"
6163 >node_id_or_hostname</CODE
6164 >
6165 : int or string                 </P
6166 ><P
6167 ></P
6168 ><UL
6169 ><LI
6170 ><P
6171 >&#13;int, Node identifier                                      </P
6172 ></LI
6173 ><LI
6174 ><P
6175 >&#13;string, Fully qualified hostname                                  </P
6176 ></LI
6177 ></UL
6178 ></LI
6179 ></UL
6180 ><P
6181 >Returns:</P
6182 ><P
6183 ></P
6184 ><UL
6185 ><LI
6186 ><P
6187 >&#13;int, 1 if successful                      </P
6188 ></LI
6189 ></UL
6190 ></DIV
6191 ><DIV
6192 CLASS="section"
6193 ><HR><H2
6194 CLASS="section"
6195 ><A
6196 NAME="DeleteConfFile"
6197 >2.42. DeleteConfFile</A
6198 ></H2
6199 ><P
6200 >Prototype:<A
6201 NAME="AEN1849"
6202 ></A
6203 ><BLOCKQUOTE
6204 CLASS="BLOCKQUOTE"
6205 ><P
6206 >DeleteConfFile (auth, conf_file_id)</P
6207 ></BLOCKQUOTE
6208 ></P
6209 ><P
6210 >Description:<A
6211 NAME="AEN1852"
6212 ></A
6213 ><BLOCKQUOTE
6214 CLASS="BLOCKQUOTE"
6215 ><P
6216 >Returns an array of structs containing details about node
6217 configuration files. If conf_file_ids is specified, only the
6218 specified configuration files will be queried.</P
6219 ></BLOCKQUOTE
6220 ></P
6221 ><P
6222 >Allowed Roles:<A
6223 NAME="AEN1855"
6224 ></A
6225 ><BLOCKQUOTE
6226 CLASS="BLOCKQUOTE"
6227 ><P
6228 >admin</P
6229 ></BLOCKQUOTE
6230 ></P
6231 ><P
6232 >Parameters:</P
6233 ><P
6234 ></P
6235 ><UL
6236 ><LI
6237 ><P
6238 >&#13;                          <CODE
6239 CLASS="parameter"
6240 >auth</CODE
6241 >
6242 : struct, API authentication structure                  </P
6243 ><P
6244 ></P
6245 ><UL
6246 ><LI
6247 ><P
6248 >&#13;                                          <CODE
6249 CLASS="parameter"
6250 >AuthMethod</CODE
6251 >
6252 : string, Authentication method to use                                  </P
6253 ></LI
6254 ></UL
6255 ></LI
6256 ><LI
6257 ><P
6258 >&#13;                          <CODE
6259 CLASS="parameter"
6260 >conf_file_id</CODE
6261 >
6262 : int, Configuration file identifier                    </P
6263 ></LI
6264 ></UL
6265 ><P
6266 >Returns:</P
6267 ><P
6268 ></P
6269 ><UL
6270 ><LI
6271 ><P
6272 >&#13;int, 1 if successful                      </P
6273 ></LI
6274 ></UL
6275 ></DIV
6276 ><DIV
6277 CLASS="section"
6278 ><HR><H2
6279 CLASS="section"
6280 ><A
6281 NAME="DeleteKey"
6282 >2.43. DeleteKey</A
6283 ></H2
6284 ><P
6285 >Prototype:<A
6286 NAME="AEN1876"
6287 ></A
6288 ><BLOCKQUOTE
6289 CLASS="BLOCKQUOTE"
6290 ><P
6291 >DeleteKey (auth, key_id)</P
6292 ></BLOCKQUOTE
6293 ></P
6294 ><P
6295 >Description:<A
6296 NAME="AEN1879"
6297 ></A
6298 ><BLOCKQUOTE
6299 CLASS="BLOCKQUOTE"
6300 ><P
6301 >Deletes a key.</P
6302 ><P
6303 >Non-admins may only delete their own keys.</P
6304 ><P
6305 >Returns 1 if successful, faults otherwise.</P
6306 ></BLOCKQUOTE
6307 ></P
6308 ><P
6309 >Allowed Roles:<A
6310 NAME="AEN1884"
6311 ></A
6312 ><BLOCKQUOTE
6313 CLASS="BLOCKQUOTE"
6314 ><P
6315 >admin, pi, tech, user</P
6316 ></BLOCKQUOTE
6317 ></P
6318 ><P
6319 >Parameters:</P
6320 ><P
6321 ></P
6322 ><UL
6323 ><LI
6324 ><P
6325 >&#13;                          <CODE
6326 CLASS="parameter"
6327 >auth</CODE
6328 >
6329 : struct, API authentication structure                  </P
6330 ><P
6331 ></P
6332 ><UL
6333 ><LI
6334 ><P
6335 >&#13;                                          <CODE
6336 CLASS="parameter"
6337 >AuthMethod</CODE
6338 >
6339 : string, Authentication method to use                                  </P
6340 ></LI
6341 ></UL
6342 ></LI
6343 ><LI
6344 ><P
6345 >&#13;                          <CODE
6346 CLASS="parameter"
6347 >key_id</CODE
6348 >
6349 : int, Key identifier                   </P
6350 ></LI
6351 ></UL
6352 ><P
6353 >Returns:</P
6354 ><P
6355 ></P
6356 ><UL
6357 ><LI
6358 ><P
6359 >&#13;int, 1 if successful                      </P
6360 ></LI
6361 ></UL
6362 ></DIV
6363 ><DIV
6364 CLASS="section"
6365 ><HR><H2
6366 CLASS="section"
6367 ><A
6368 NAME="DeleteKeyType"
6369 >2.44. DeleteKeyType</A
6370 ></H2
6371 ><P
6372 >Prototype:<A
6373 NAME="AEN1905"
6374 ></A
6375 ><BLOCKQUOTE
6376 CLASS="BLOCKQUOTE"
6377 ><P
6378 >DeleteKeyType (auth, name)</P
6379 ></BLOCKQUOTE
6380 ></P
6381 ><P
6382 >Description:<A
6383 NAME="AEN1908"
6384 ></A
6385 ><BLOCKQUOTE
6386 CLASS="BLOCKQUOTE"
6387 ><P
6388 >Deletes a key type.</P
6389 ><P
6390 >WARNING: This will cause the deletion of all keys of this type.</P
6391 ><P
6392 >Returns 1 if successful, faults otherwise.</P
6393 ></BLOCKQUOTE
6394 ></P
6395 ><P
6396 >Allowed Roles:<A
6397 NAME="AEN1913"
6398 ></A
6399 ><BLOCKQUOTE
6400 CLASS="BLOCKQUOTE"
6401 ><P
6402 >admin</P
6403 ></BLOCKQUOTE
6404 ></P
6405 ><P
6406 >Parameters:</P
6407 ><P
6408 ></P
6409 ><UL
6410 ><LI
6411 ><P
6412 >&#13;                          <CODE
6413 CLASS="parameter"
6414 >auth</CODE
6415 >
6416 : struct, API authentication structure                  </P
6417 ><P
6418 ></P
6419 ><UL
6420 ><LI
6421 ><P
6422 >&#13;                                          <CODE
6423 CLASS="parameter"
6424 >AuthMethod</CODE
6425 >
6426 : string, Authentication method to use                                  </P
6427 ></LI
6428 ></UL
6429 ></LI
6430 ><LI
6431 ><P
6432 >&#13;                          <CODE
6433 CLASS="parameter"
6434 >name</CODE
6435 >
6436 : string, Key type                      </P
6437 ></LI
6438 ></UL
6439 ><P
6440 >Returns:</P
6441 ><P
6442 ></P
6443 ><UL
6444 ><LI
6445 ><P
6446 >&#13;int, 1 if successful                      </P
6447 ></LI
6448 ></UL
6449 ></DIV
6450 ><DIV
6451 CLASS="section"
6452 ><HR><H2
6453 CLASS="section"
6454 ><A
6455 NAME="DeleteMessage"
6456 >2.45. DeleteMessage</A
6457 ></H2
6458 ><P
6459 >Prototype:<A
6460 NAME="AEN1934"
6461 ></A
6462 ><BLOCKQUOTE
6463 CLASS="BLOCKQUOTE"
6464 ><P
6465 >DeleteMessage (auth, message_id)</P
6466 ></BLOCKQUOTE
6467 ></P
6468 ><P
6469 >Description:<A
6470 NAME="AEN1937"
6471 ></A
6472 ><BLOCKQUOTE
6473 CLASS="BLOCKQUOTE"
6474 ><P
6475 >Deletes a message template.</P
6476 ><P
6477 >Returns 1 if successful, faults otherwise.</P
6478 ></BLOCKQUOTE
6479 ></P
6480 ><P
6481 >Allowed Roles:<A
6482 NAME="AEN1941"
6483 ></A
6484 ><BLOCKQUOTE
6485 CLASS="BLOCKQUOTE"
6486 ><P
6487 >admin</P
6488 ></BLOCKQUOTE
6489 ></P
6490 ><P
6491 >Parameters:</P
6492 ><P
6493 ></P
6494 ><UL
6495 ><LI
6496 ><P
6497 >&#13;                          <CODE
6498 CLASS="parameter"
6499 >auth</CODE
6500 >
6501 : struct, API authentication structure                  </P
6502 ><P
6503 ></P
6504 ><UL
6505 ><LI
6506 ><P
6507 >&#13;                                          <CODE
6508 CLASS="parameter"
6509 >AuthMethod</CODE
6510 >
6511 : string, Authentication method to use                                  </P
6512 ></LI
6513 ></UL
6514 ></LI
6515 ><LI
6516 ><P
6517 >&#13;                          <CODE
6518 CLASS="parameter"
6519 >message_id</CODE
6520 >
6521 : string, Message identifier                    </P
6522 ></LI
6523 ></UL
6524 ><P
6525 >Returns:</P
6526 ><P
6527 ></P
6528 ><UL
6529 ><LI
6530 ><P
6531 >&#13;int, 1 if successful                      </P
6532 ></LI
6533 ></UL
6534 ></DIV
6535 ><DIV
6536 CLASS="section"
6537 ><HR><H2
6538 CLASS="section"
6539 ><A
6540 NAME="DeleteNetworkMethod"
6541 >2.46. DeleteNetworkMethod</A
6542 ></H2
6543 ><P
6544 >Prototype:<A
6545 NAME="AEN1962"
6546 ></A
6547 ><BLOCKQUOTE
6548 CLASS="BLOCKQUOTE"
6549 ><P
6550 >DeleteNetworkMethod (auth, name)</P
6551 ></BLOCKQUOTE
6552 ></P
6553 ><P
6554 >Description:<A
6555 NAME="AEN1965"
6556 ></A
6557 ><BLOCKQUOTE
6558 CLASS="BLOCKQUOTE"
6559 ><P
6560 >Deletes a network method.</P
6561 ><P
6562 >WARNING: This will cause the deletion of all network interfaces
6563 that use this method.</P
6564 ><P
6565 >Returns 1 if successful, faults otherwise.</P
6566 ></BLOCKQUOTE
6567 ></P
6568 ><P
6569 >Allowed Roles:<A
6570 NAME="AEN1970"
6571 ></A
6572 ><BLOCKQUOTE
6573 CLASS="BLOCKQUOTE"
6574 ><P
6575 >admin</P
6576 ></BLOCKQUOTE
6577 ></P
6578 ><P
6579 >Parameters:</P
6580 ><P
6581 ></P
6582 ><UL
6583 ><LI
6584 ><P
6585 >&#13;                          <CODE
6586 CLASS="parameter"
6587 >auth</CODE
6588 >
6589 : struct, API authentication structure                  </P
6590 ><P
6591 ></P
6592 ><UL
6593 ><LI
6594 ><P
6595 >&#13;                                          <CODE
6596 CLASS="parameter"
6597 >AuthMethod</CODE
6598 >
6599 : string, Authentication method to use                                  </P
6600 ></LI
6601 ></UL
6602 ></LI
6603 ><LI
6604 ><P
6605 >&#13;                          <CODE
6606 CLASS="parameter"
6607 >name</CODE
6608 >
6609 : string, Network method                        </P
6610 ></LI
6611 ></UL
6612 ><P
6613 >Returns:</P
6614 ><P
6615 ></P
6616 ><UL
6617 ><LI
6618 ><P
6619 >&#13;int, 1 if successful                      </P
6620 ></LI
6621 ></UL
6622 ></DIV
6623 ><DIV
6624 CLASS="section"
6625 ><HR><H2
6626 CLASS="section"
6627 ><A
6628 NAME="DeleteNetworkType"
6629 >2.47. DeleteNetworkType</A
6630 ></H2
6631 ><P
6632 >Prototype:<A
6633 NAME="AEN1991"
6634 ></A
6635 ><BLOCKQUOTE
6636 CLASS="BLOCKQUOTE"
6637 ><P
6638 >DeleteNetworkType (auth, name)</P
6639 ></BLOCKQUOTE
6640 ></P
6641 ><P
6642 >Description:<A
6643 NAME="AEN1994"
6644 ></A
6645 ><BLOCKQUOTE
6646 CLASS="BLOCKQUOTE"
6647 ><P
6648 >Deletes a network type.</P
6649 ><P
6650 >WARNING: This will cause the deletion of all network interfaces
6651 that use this type.</P
6652 ><P
6653 >Returns 1 if successful, faults otherwise.</P
6654 ></BLOCKQUOTE
6655 ></P
6656 ><P
6657 >Allowed Roles:<A
6658 NAME="AEN1999"
6659 ></A
6660 ><BLOCKQUOTE
6661 CLASS="BLOCKQUOTE"
6662 ><P
6663 >admin</P
6664 ></BLOCKQUOTE
6665 ></P
6666 ><P
6667 >Parameters:</P
6668 ><P
6669 ></P
6670 ><UL
6671 ><LI
6672 ><P
6673 >&#13;                          <CODE
6674 CLASS="parameter"
6675 >auth</CODE
6676 >
6677 : struct, API authentication structure                  </P
6678 ><P
6679 ></P
6680 ><UL
6681 ><LI
6682 ><P
6683 >&#13;                                          <CODE
6684 CLASS="parameter"
6685 >AuthMethod</CODE
6686 >
6687 : string, Authentication method to use                                  </P
6688 ></LI
6689 ></UL
6690 ></LI
6691 ><LI
6692 ><P
6693 >&#13;                          <CODE
6694 CLASS="parameter"
6695 >name</CODE
6696 >
6697 : string, Network type                  </P
6698 ></LI
6699 ></UL
6700 ><P
6701 >Returns:</P
6702 ><P
6703 ></P
6704 ><UL
6705 ><LI
6706 ><P
6707 >&#13;int, 1 if successful                      </P
6708 ></LI
6709 ></UL
6710 ></DIV
6711 ><DIV
6712 CLASS="section"
6713 ><HR><H2
6714 CLASS="section"
6715 ><A
6716 NAME="DeleteNodeFromNodeGroup"
6717 >2.48. DeleteNodeFromNodeGroup</A
6718 ></H2
6719 ><P
6720 >Prototype:<A
6721 NAME="AEN2020"
6722 ></A
6723 ><BLOCKQUOTE
6724 CLASS="BLOCKQUOTE"
6725 ><P
6726 >DeleteNodeFromNodeGroup (auth, node_id_or_hostname, nodegroup_id_or_name)</P
6727 ></BLOCKQUOTE
6728 ></P
6729 ><P
6730 >Description:<A
6731 NAME="AEN2023"
6732 ></A
6733 ><BLOCKQUOTE
6734 CLASS="BLOCKQUOTE"
6735 ><P
6736 >Removes a node from the specified node group.</P
6737 ><P
6738 >Returns 1 if successful, faults otherwise.</P
6739 ></BLOCKQUOTE
6740 ></P
6741 ><P
6742 >Allowed Roles:<A
6743 NAME="AEN2027"
6744 ></A
6745 ><BLOCKQUOTE
6746 CLASS="BLOCKQUOTE"
6747 ><P
6748 >admin</P
6749 ></BLOCKQUOTE
6750 ></P
6751 ><P
6752 >Parameters:</P
6753 ><P
6754 ></P
6755 ><UL
6756 ><LI
6757 ><P
6758 >&#13;                          <CODE
6759 CLASS="parameter"
6760 >auth</CODE
6761 >
6762 : struct, API authentication structure                  </P
6763 ><P
6764 ></P
6765 ><UL
6766 ><LI
6767 ><P
6768 >&#13;                                          <CODE
6769 CLASS="parameter"
6770 >AuthMethod</CODE
6771 >
6772 : string, Authentication method to use                                  </P
6773 ></LI
6774 ></UL
6775 ></LI
6776 ><LI
6777 ><P
6778 >&#13;                          <CODE
6779 CLASS="parameter"
6780 >node_id_or_hostname</CODE
6781 >
6782 : int or string                 </P
6783 ><P
6784 ></P
6785 ><UL
6786 ><LI
6787 ><P
6788 >&#13;int, Node identifier                                      </P
6789 ></LI
6790 ><LI
6791 ><P
6792 >&#13;string, Fully qualified hostname                                  </P
6793 ></LI
6794 ></UL
6795 ></LI
6796 ><LI
6797 ><P
6798 >&#13;                          <CODE
6799 CLASS="parameter"
6800 >nodegroup_id_or_name</CODE
6801 >
6802 : int or string                 </P
6803 ><P
6804 ></P
6805 ><UL
6806 ><LI
6807 ><P
6808 >&#13;int, Node group identifier                                        </P
6809 ></LI
6810 ><LI
6811 ><P
6812 >&#13;string, Node group name                                   </P
6813 ></LI
6814 ></UL
6815 ></LI
6816 ></UL
6817 ><P
6818 >Returns:</P
6819 ><P
6820 ></P
6821 ><UL
6822 ><LI
6823 ><P
6824 >&#13;int, 1 if successful                      </P
6825 ></LI
6826 ></UL
6827 ></DIV
6828 ><DIV
6829 CLASS="section"
6830 ><HR><H2
6831 CLASS="section"
6832 ><A
6833 NAME="DeleteNodeFromPCU"
6834 >2.49. DeleteNodeFromPCU</A
6835 ></H2
6836 ><P
6837 >Prototype:<A
6838 NAME="AEN2061"
6839 ></A
6840 ><BLOCKQUOTE
6841 CLASS="BLOCKQUOTE"
6842 ><P
6843 >DeleteNodeFromPCU (auth, node_id_or_hostname, pcu_id)</P
6844 ></BLOCKQUOTE
6845 ></P
6846 ><P
6847 >Description:<A
6848 NAME="AEN2064"
6849 ></A
6850 ><BLOCKQUOTE
6851 CLASS="BLOCKQUOTE"
6852 ><P
6853 >Deletes a node from a PCU.</P
6854 ><P
6855 >Non-admins may only update PCUs at their sites.</P
6856 ><P
6857 >Returns 1 if successful, faults otherwise.</P
6858 ></BLOCKQUOTE
6859 ></P
6860 ><P
6861 >Allowed Roles:<A
6862 NAME="AEN2069"
6863 ></A
6864 ><BLOCKQUOTE
6865 CLASS="BLOCKQUOTE"
6866 ><P
6867 >admin, pi, tech</P
6868 ></BLOCKQUOTE
6869 ></P
6870 ><P
6871 >Parameters:</P
6872 ><P
6873 ></P
6874 ><UL
6875 ><LI
6876 ><P
6877 >&#13;                          <CODE
6878 CLASS="parameter"
6879 >auth</CODE
6880 >
6881 : struct, API authentication structure                  </P
6882 ><P
6883 ></P
6884 ><UL
6885 ><LI
6886 ><P
6887 >&#13;                                          <CODE
6888 CLASS="parameter"
6889 >AuthMethod</CODE
6890 >
6891 : string, Authentication method to use                                  </P
6892 ></LI
6893 ></UL
6894 ></LI
6895 ><LI
6896 ><P
6897 >&#13;                          <CODE
6898 CLASS="parameter"
6899 >node_id_or_hostname</CODE
6900 >
6901 : int or string                 </P
6902 ><P
6903 ></P
6904 ><UL
6905 ><LI
6906 ><P
6907 >&#13;int, Node identifier                                      </P
6908 ></LI
6909 ><LI
6910 ><P
6911 >&#13;string, Fully qualified hostname                                  </P
6912 ></LI
6913 ></UL
6914 ></LI
6915 ><LI
6916 ><P
6917 >&#13;                          <CODE
6918 CLASS="parameter"
6919 >pcu_id</CODE
6920 >
6921 : int, PCU identifier                   </P
6922 ></LI
6923 ></UL
6924 ><P
6925 >Returns:</P
6926 ><P
6927 ></P
6928 ><UL
6929 ><LI
6930 ><P
6931 >&#13;int, 1 if successful                      </P
6932 ></LI
6933 ></UL
6934 ></DIV
6935 ><DIV
6936 CLASS="section"
6937 ><HR><H2
6938 CLASS="section"
6939 ><A
6940 NAME="DeleteNodeGroup"
6941 >2.50. DeleteNodeGroup</A
6942 ></H2
6943 ><P
6944 >Prototype:<A
6945 NAME="AEN2098"
6946 ></A
6947 ><BLOCKQUOTE
6948 CLASS="BLOCKQUOTE"
6949 ><P
6950 >DeleteNodeGroup (auth, node_group_id_or_name)</P
6951 ></BLOCKQUOTE
6952 ></P
6953 ><P
6954 >Description:<A
6955 NAME="AEN2101"
6956 ></A
6957 ><BLOCKQUOTE
6958 CLASS="BLOCKQUOTE"
6959 ><P
6960 >Delete an existing Node Group.</P
6961 ><P
6962 >ins may delete any node group</P
6963 ><P
6964 >Returns 1 if successful, faults otherwise.</P
6965 ></BLOCKQUOTE
6966 ></P
6967 ><P
6968 >Allowed Roles:<A
6969 NAME="AEN2106"
6970 ></A
6971 ><BLOCKQUOTE
6972 CLASS="BLOCKQUOTE"
6973 ><P
6974 >admin</P
6975 ></BLOCKQUOTE
6976 ></P
6977 ><P
6978 >Parameters:</P
6979 ><P
6980 ></P
6981 ><UL
6982 ><LI
6983 ><P
6984 >&#13;                          <CODE
6985 CLASS="parameter"
6986 >auth</CODE
6987 >
6988 : struct, API authentication structure                  </P
6989 ><P
6990 ></P
6991 ><UL
6992 ><LI
6993 ><P
6994 >&#13;                                          <CODE
6995 CLASS="parameter"
6996 >AuthMethod</CODE
6997 >
6998 : string, Authentication method to use                                  </P
6999 ></LI
7000 ></UL
7001 ></LI
7002 ><LI
7003 ><P
7004 >&#13;                          <CODE
7005 CLASS="parameter"
7006 >node_group_id_or_name</CODE
7007 >
7008 : int or string                 </P
7009 ><P
7010 ></P
7011 ><UL
7012 ><LI
7013 ><P
7014 >&#13;int, Node group identifier                                        </P
7015 ></LI
7016 ><LI
7017 ><P
7018 >&#13;string, Node group name                                   </P
7019 ></LI
7020 ></UL
7021 ></LI
7022 ></UL
7023 ><P
7024 >Returns:</P
7025 ><P
7026 ></P
7027 ><UL
7028 ><LI
7029 ><P
7030 >&#13;int, 1 if successful                      </P
7031 ></LI
7032 ></UL
7033 ></DIV
7034 ><DIV
7035 CLASS="section"
7036 ><HR><H2
7037 CLASS="section"
7038 ><A
7039 NAME="DeleteNodeNetwork"
7040 >2.51. DeleteNodeNetwork</A
7041 ></H2
7042 ><P
7043 >Prototype:<A
7044 NAME="AEN2132"
7045 ></A
7046 ><BLOCKQUOTE
7047 CLASS="BLOCKQUOTE"
7048 ><P
7049 >DeleteNodeNetwork (auth, nodenetwork_id)</P
7050 ></BLOCKQUOTE
7051 ></P
7052 ><P
7053 >Description:<A
7054 NAME="AEN2135"
7055 ></A
7056 ><BLOCKQUOTE
7057 CLASS="BLOCKQUOTE"
7058 ><P
7059 >Deletes an existing node network interface.</P
7060 ><P
7061 >Admins may delete any node network. PIs and techs may only delete
7062 node network interfaces associated with nodes at their sites.</P
7063 ><P
7064 >Returns 1 if successful, faults otherwise.</P
7065 ></BLOCKQUOTE
7066 ></P
7067 ><P
7068 >Allowed Roles:<A
7069 NAME="AEN2140"
7070 ></A
7071 ><BLOCKQUOTE
7072 CLASS="BLOCKQUOTE"
7073 ><P
7074 >admin, pi, tech</P
7075 ></BLOCKQUOTE
7076 ></P
7077 ><P
7078 >Parameters:</P
7079 ><P
7080 ></P
7081 ><UL
7082 ><LI
7083 ><P
7084 >&#13;                          <CODE
7085 CLASS="parameter"
7086 >auth</CODE
7087 >
7088 : struct, API authentication structure                  </P
7089 ><P
7090 ></P
7091 ><UL
7092 ><LI
7093 ><P
7094 >&#13;                                          <CODE
7095 CLASS="parameter"
7096 >AuthMethod</CODE
7097 >
7098 : string, Authentication method to use                                  </P
7099 ></LI
7100 ></UL
7101 ></LI
7102 ><LI
7103 ><P
7104 >&#13;                          <CODE
7105 CLASS="parameter"
7106 >nodenetwork_id</CODE
7107 >
7108 : int, Node interface identifier                        </P
7109 ></LI
7110 ></UL
7111 ><P
7112 >Returns:</P
7113 ><P
7114 ></P
7115 ><UL
7116 ><LI
7117 ><P
7118 >&#13;int, 1 if successful                      </P
7119 ></LI
7120 ></UL
7121 ></DIV
7122 ><DIV
7123 CLASS="section"
7124 ><HR><H2
7125 CLASS="section"
7126 ><A
7127 NAME="DeleteNode"
7128 >2.52. DeleteNode</A
7129 ></H2
7130 ><P
7131 >Prototype:<A
7132 NAME="AEN2161"
7133 ></A
7134 ><BLOCKQUOTE
7135 CLASS="BLOCKQUOTE"
7136 ><P
7137 >DeleteNode (auth, node_id_or_hostname)</P
7138 ></BLOCKQUOTE
7139 ></P
7140 ><P
7141 >Description:<A
7142 NAME="AEN2164"
7143 ></A
7144 ><BLOCKQUOTE
7145 CLASS="BLOCKQUOTE"
7146 ><P
7147 >Mark an existing node as deleted.</P
7148 ><P
7149 >PIs and techs may only delete nodes at their own sites. ins may
7150 delete nodes at any site.</P
7151 ><P
7152 >Returns 1 if successful, faults otherwise.</P
7153 ></BLOCKQUOTE
7154 ></P
7155 ><P
7156 >Allowed Roles:<A
7157 NAME="AEN2169"
7158 ></A
7159 ><BLOCKQUOTE
7160 CLASS="BLOCKQUOTE"
7161 ><P
7162 >admin, pi, tech</P
7163 ></BLOCKQUOTE
7164 ></P
7165 ><P
7166 >Parameters:</P
7167 ><P
7168 ></P
7169 ><UL
7170 ><LI
7171 ><P
7172 >&#13;                          <CODE
7173 CLASS="parameter"
7174 >auth</CODE
7175 >
7176 : struct, API authentication structure                  </P
7177 ><P
7178 ></P
7179 ><UL
7180 ><LI
7181 ><P
7182 >&#13;                                          <CODE
7183 CLASS="parameter"
7184 >AuthMethod</CODE
7185 >
7186 : string, Authentication method to use                                  </P
7187 ></LI
7188 ></UL
7189 ></LI
7190 ><LI
7191 ><P
7192 >&#13;                          <CODE
7193 CLASS="parameter"
7194 >node_id_or_hostname</CODE
7195 >
7196 : int or string                 </P
7197 ><P
7198 ></P
7199 ><UL
7200 ><LI
7201 ><P
7202 >&#13;int, Node identifier                                      </P
7203 ></LI
7204 ><LI
7205 ><P
7206 >&#13;string, Fully qualified hostname                                  </P
7207 ></LI
7208 ></UL
7209 ></LI
7210 ></UL
7211 ><P
7212 >Returns:</P
7213 ><P
7214 ></P
7215 ><UL
7216 ><LI
7217 ><P
7218 >&#13;int, 1 if successful                      </P
7219 ></LI
7220 ></UL
7221 ></DIV
7222 ><DIV
7223 CLASS="section"
7224 ><HR><H2
7225 CLASS="section"
7226 ><A
7227 NAME="DeletePCU"
7228 >2.53. DeletePCU</A
7229 ></H2
7230 ><P
7231 >Prototype:<A
7232 NAME="AEN2195"
7233 ></A
7234 ><BLOCKQUOTE
7235 CLASS="BLOCKQUOTE"
7236 ><P
7237 >DeletePCU (auth, pcu_id)</P
7238 ></BLOCKQUOTE
7239 ></P
7240 ><P
7241 >Description:<A
7242 NAME="AEN2198"
7243 ></A
7244 ><BLOCKQUOTE
7245 CLASS="BLOCKQUOTE"
7246 ><P
7247 >Deletes a PCU.</P
7248 ><P
7249 >Non-admins may only delete PCUs at their sites.</P
7250 ><P
7251 >Returns 1 if successful, faults otherwise.</P
7252 ></BLOCKQUOTE
7253 ></P
7254 ><P
7255 >Allowed Roles:<A
7256 NAME="AEN2203"
7257 ></A
7258 ><BLOCKQUOTE
7259 CLASS="BLOCKQUOTE"
7260 ><P
7261 >admin, pi, tech</P
7262 ></BLOCKQUOTE
7263 ></P
7264 ><P
7265 >Parameters:</P
7266 ><P
7267 ></P
7268 ><UL
7269 ><LI
7270 ><P
7271 >&#13;                          <CODE
7272 CLASS="parameter"
7273 >auth</CODE
7274 >
7275 : struct, API authentication structure                  </P
7276 ><P
7277 ></P
7278 ><UL
7279 ><LI
7280 ><P
7281 >&#13;                                          <CODE
7282 CLASS="parameter"
7283 >AuthMethod</CODE
7284 >
7285 : string, Authentication method to use                                  </P
7286 ></LI
7287 ></UL
7288 ></LI
7289 ><LI
7290 ><P
7291 >&#13;                          <CODE
7292 CLASS="parameter"
7293 >pcu_id</CODE
7294 >
7295 : int, PCU identifier                   </P
7296 ></LI
7297 ></UL
7298 ><P
7299 >Returns:</P
7300 ><P
7301 ></P
7302 ><UL
7303 ><LI
7304 ><P
7305 >&#13;int, 1 if successful                      </P
7306 ></LI
7307 ></UL
7308 ></DIV
7309 ><DIV
7310 CLASS="section"
7311 ><HR><H2
7312 CLASS="section"
7313 ><A
7314 NAME="DeletePeer"
7315 >2.54. DeletePeer</A
7316 ></H2
7317 ><P
7318 >Prototype:<A
7319 NAME="AEN2224"
7320 ></A
7321 ><BLOCKQUOTE
7322 CLASS="BLOCKQUOTE"
7323 ><P
7324 >DeletePeer (auth, peer_id_or_name)</P
7325 ></BLOCKQUOTE
7326 ></P
7327 ><P
7328 >Description:<A
7329 NAME="AEN2227"
7330 ></A
7331 ><BLOCKQUOTE
7332 CLASS="BLOCKQUOTE"
7333 ><P
7334 >Mark an existing peer as deleted. All entities (e.g., slices,
7335 keys, nodes, etc.) for which this peer is authoritative will also
7336 be deleted or marked as deleted.</P
7337 ><P
7338 >Returns 1 if successful, faults otherwise.</P
7339 ></BLOCKQUOTE
7340 ></P
7341 ><P
7342 >Allowed Roles:<A
7343 NAME="AEN2231"
7344 ></A
7345 ><BLOCKQUOTE
7346 CLASS="BLOCKQUOTE"
7347 ><P
7348 >admin</P
7349 ></BLOCKQUOTE
7350 ></P
7351 ><P
7352 >Parameters:</P
7353 ><P
7354 ></P
7355 ><UL
7356 ><LI
7357 ><P
7358 >&#13;                          <CODE
7359 CLASS="parameter"
7360 >auth</CODE
7361 >
7362 : struct, API authentication structure                  </P
7363 ><P
7364 ></P
7365 ><UL
7366 ><LI
7367 ><P
7368 >&#13;                                          <CODE
7369 CLASS="parameter"
7370 >AuthMethod</CODE
7371 >
7372 : string, Authentication method to use                                  </P
7373 ></LI
7374 ></UL
7375 ></LI
7376 ><LI
7377 ><P
7378 >&#13;                          <CODE
7379 CLASS="parameter"
7380 >peer_id_or_name</CODE
7381 >
7382 : int or string                 </P
7383 ><P
7384 ></P
7385 ><UL
7386 ><LI
7387 ><P
7388 >&#13;int, Peer identifier                                      </P
7389 ></LI
7390 ><LI
7391 ><P
7392 >&#13;string, Peer name                                 </P
7393 ></LI
7394 ></UL
7395 ></LI
7396 ></UL
7397 ><P
7398 >Returns:</P
7399 ><P
7400 ></P
7401 ><UL
7402 ><LI
7403 ><P
7404 >&#13;int, 1 if successful                      </P
7405 ></LI
7406 ></UL
7407 ></DIV
7408 ><DIV
7409 CLASS="section"
7410 ><HR><H2
7411 CLASS="section"
7412 ><A
7413 NAME="DeletePersonFromSite"
7414 >2.55. DeletePersonFromSite</A
7415 ></H2
7416 ><P
7417 >Prototype:<A
7418 NAME="AEN2257"
7419 ></A
7420 ><BLOCKQUOTE
7421 CLASS="BLOCKQUOTE"
7422 ><P
7423 >DeletePersonFromSite (auth, person_id_or_email, site_id_or_login_base)</P
7424 ></BLOCKQUOTE
7425 ></P
7426 ><P
7427 >Description:<A
7428 NAME="AEN2260"
7429 ></A
7430 ><BLOCKQUOTE
7431 CLASS="BLOCKQUOTE"
7432 ><P
7433 >Removes the specified person from the specified site. If the
7434 person is not a member of the specified site, no error is
7435 returned.</P
7436 ><P
7437 >Returns 1 if successful, faults otherwise.</P
7438 ></BLOCKQUOTE
7439 ></P
7440 ><P
7441 >Allowed Roles:<A
7442 NAME="AEN2264"
7443 ></A
7444 ><BLOCKQUOTE
7445 CLASS="BLOCKQUOTE"
7446 ><P
7447 >admin</P
7448 ></BLOCKQUOTE
7449 ></P
7450 ><P
7451 >Parameters:</P
7452 ><P
7453 ></P
7454 ><UL
7455 ><LI
7456 ><P
7457 >&#13;                          <CODE
7458 CLASS="parameter"
7459 >auth</CODE
7460 >
7461 : struct, API authentication structure                  </P
7462 ><P
7463 ></P
7464 ><UL
7465 ><LI
7466 ><P
7467 >&#13;                                          <CODE
7468 CLASS="parameter"
7469 >AuthMethod</CODE
7470 >
7471 : string, Authentication method to use                                  </P
7472 ></LI
7473 ></UL
7474 ></LI
7475 ><LI
7476 ><P
7477 >&#13;                          <CODE
7478 CLASS="parameter"
7479 >person_id_or_email</CODE
7480 >
7481 : int or string                 </P
7482 ><P
7483 ></P
7484 ><UL
7485 ><LI
7486 ><P
7487 >&#13;int, User identifier                                      </P
7488 ></LI
7489 ><LI
7490 ><P
7491 >&#13;string, Primary e-mail address                                    </P
7492 ></LI
7493 ></UL
7494 ></LI
7495 ><LI
7496 ><P
7497 >&#13;                          <CODE
7498 CLASS="parameter"
7499 >site_id_or_login_base</CODE
7500 >
7501 : int or string                 </P
7502 ><P
7503 ></P
7504 ><UL
7505 ><LI
7506 ><P
7507 >&#13;int, Site identifier                                      </P
7508 ></LI
7509 ><LI
7510 ><P
7511 >&#13;string, Site slice prefix                                 </P
7512 ></LI
7513 ></UL
7514 ></LI
7515 ></UL
7516 ><P
7517 >Returns:</P
7518 ><P
7519 ></P
7520 ><UL
7521 ><LI
7522 ><P
7523 >&#13;int, 1 if successful                      </P
7524 ></LI
7525 ></UL
7526 ></DIV
7527 ><DIV
7528 CLASS="section"
7529 ><HR><H2
7530 CLASS="section"
7531 ><A
7532 NAME="DeletePersonFromSlice"
7533 >2.56. DeletePersonFromSlice</A
7534 ></H2
7535 ><P
7536 >Prototype:<A
7537 NAME="AEN2298"
7538 ></A
7539 ><BLOCKQUOTE
7540 CLASS="BLOCKQUOTE"
7541 ><P
7542 >DeletePersonFromSlice (auth, person_id_or_email, slice_id_or_name)</P
7543 ></BLOCKQUOTE
7544 ></P
7545 ><P
7546 >Description:<A
7547 NAME="AEN2301"
7548 ></A
7549 ><BLOCKQUOTE
7550 CLASS="BLOCKQUOTE"
7551 ><P
7552 >Deletes the specified person from the specified slice. If the person is
7553 not a member of the slice, no errors are returned.</P
7554 ><P
7555 >Returns 1 if successful, faults otherwise.</P
7556 ></BLOCKQUOTE
7557 ></P
7558 ><P
7559 >Allowed Roles:<A
7560 NAME="AEN2305"
7561 ></A
7562 ><BLOCKQUOTE
7563 CLASS="BLOCKQUOTE"
7564 ><P
7565 >admin, pi</P
7566 ></BLOCKQUOTE
7567 ></P
7568 ><P
7569 >Parameters:</P
7570 ><P
7571 ></P
7572 ><UL
7573 ><LI
7574 ><P
7575 >&#13;                          <CODE
7576 CLASS="parameter"
7577 >auth</CODE
7578 >
7579 : struct, API authentication structure                  </P
7580 ><P
7581 ></P
7582 ><UL
7583 ><LI
7584 ><P
7585 >&#13;                                          <CODE
7586 CLASS="parameter"
7587 >AuthMethod</CODE
7588 >
7589 : string, Authentication method to use                                  </P
7590 ></LI
7591 ></UL
7592 ></LI
7593 ><LI
7594 ><P
7595 >&#13;                          <CODE
7596 CLASS="parameter"
7597 >person_id_or_email</CODE
7598 >
7599 : int or string                 </P
7600 ><P
7601 ></P
7602 ><UL
7603 ><LI
7604 ><P
7605 >&#13;int, User identifier                                      </P
7606 ></LI
7607 ><LI
7608 ><P
7609 >&#13;string, Primary e-mail address                                    </P
7610 ></LI
7611 ></UL
7612 ></LI
7613 ><LI
7614 ><P
7615 >&#13;                          <CODE
7616 CLASS="parameter"
7617 >slice_id_or_name</CODE
7618 >
7619 : int or string                 </P
7620 ><P
7621 ></P
7622 ><UL
7623 ><LI
7624 ><P
7625 >&#13;int, Slice identifier                                     </P
7626 ></LI
7627 ><LI
7628 ><P
7629 >&#13;string, Slice name                                        </P
7630 ></LI
7631 ></UL
7632 ></LI
7633 ></UL
7634 ><P
7635 >Returns:</P
7636 ><P
7637 ></P
7638 ><UL
7639 ><LI
7640 ><P
7641 >&#13;int, 1 if successful                      </P
7642 ></LI
7643 ></UL
7644 ></DIV
7645 ><DIV
7646 CLASS="section"
7647 ><HR><H2
7648 CLASS="section"
7649 ><A
7650 NAME="DeletePerson"
7651 >2.57. DeletePerson</A
7652 ></H2
7653 ><P
7654 >Prototype:<A
7655 NAME="AEN2339"
7656 ></A
7657 ><BLOCKQUOTE
7658 CLASS="BLOCKQUOTE"
7659 ><P
7660 >DeletePerson (auth, person_id_or_email)</P
7661 ></BLOCKQUOTE
7662 ></P
7663 ><P
7664 >Description:<A
7665 NAME="AEN2342"
7666 ></A
7667 ><BLOCKQUOTE
7668 CLASS="BLOCKQUOTE"
7669 ><P
7670 >Mark an existing account as deleted.</P
7671 ><P
7672 >Users and techs can only delete themselves. PIs can only delete
7673 themselves and other non-PIs at their sites. ins can delete
7674 anyone.</P
7675 ><P
7676 >Returns 1 if successful, faults otherwise.</P
7677 ></BLOCKQUOTE
7678 ></P
7679 ><P
7680 >Allowed Roles:<A
7681 NAME="AEN2347"
7682 ></A
7683 ><BLOCKQUOTE
7684 CLASS="BLOCKQUOTE"
7685 ><P
7686 >admin, pi, user, tech</P
7687 ></BLOCKQUOTE
7688 ></P
7689 ><P
7690 >Parameters:</P
7691 ><P
7692 ></P
7693 ><UL
7694 ><LI
7695 ><P
7696 >&#13;                          <CODE
7697 CLASS="parameter"
7698 >auth</CODE
7699 >
7700 : struct, API authentication structure                  </P
7701 ><P
7702 ></P
7703 ><UL
7704 ><LI
7705 ><P
7706 >&#13;                                          <CODE
7707 CLASS="parameter"
7708 >AuthMethod</CODE
7709 >
7710 : string, Authentication method to use                                  </P
7711 ></LI
7712 ></UL
7713 ></LI
7714 ><LI
7715 ><P
7716 >&#13;                          <CODE
7717 CLASS="parameter"
7718 >person_id_or_email</CODE
7719 >
7720 : int or string                 </P
7721 ><P
7722 ></P
7723 ><UL
7724 ><LI
7725 ><P
7726 >&#13;int, User identifier                                      </P
7727 ></LI
7728 ><LI
7729 ><P
7730 >&#13;string, Primary e-mail address                                    </P
7731 ></LI
7732 ></UL
7733 ></LI
7734 ></UL
7735 ><P
7736 >Returns:</P
7737 ><P
7738 ></P
7739 ><UL
7740 ><LI
7741 ><P
7742 >&#13;int, 1 if successful                      </P
7743 ></LI
7744 ></UL
7745 ></DIV
7746 ><DIV
7747 CLASS="section"
7748 ><HR><H2
7749 CLASS="section"
7750 ><A
7751 NAME="DeleteRoleFromPerson"
7752 >2.58. DeleteRoleFromPerson</A
7753 ></H2
7754 ><P
7755 >Prototype:<A
7756 NAME="AEN2373"
7757 ></A
7758 ><BLOCKQUOTE
7759 CLASS="BLOCKQUOTE"
7760 ><P
7761 >DeleteRoleFromPerson (auth, role_id_or_name, person_id_or_email)</P
7762 ></BLOCKQUOTE
7763 ></P
7764 ><P
7765 >Description:<A
7766 NAME="AEN2376"
7767 ></A
7768 ><BLOCKQUOTE
7769 CLASS="BLOCKQUOTE"
7770 ><P
7771 >Deletes the specified role from the person.</P
7772 ><P
7773 >PIs can only revoke the tech and user roles from users and techs
7774 at their sites. ins can revoke any role from any user.</P
7775 ><P
7776 >Returns 1 if successful, faults otherwise.</P
7777 ></BLOCKQUOTE
7778 ></P
7779 ><P
7780 >Allowed Roles:<A
7781 NAME="AEN2381"
7782 ></A
7783 ><BLOCKQUOTE
7784 CLASS="BLOCKQUOTE"
7785 ><P
7786 >admin, pi</P
7787 ></BLOCKQUOTE
7788 ></P
7789 ><P
7790 >Parameters:</P
7791 ><P
7792 ></P
7793 ><UL
7794 ><LI
7795 ><P
7796 >&#13;                          <CODE
7797 CLASS="parameter"
7798 >auth</CODE
7799 >
7800 : struct, API authentication structure                  </P
7801 ><P
7802 ></P
7803 ><UL
7804 ><LI
7805 ><P
7806 >&#13;                                          <CODE
7807 CLASS="parameter"
7808 >AuthMethod</CODE
7809 >
7810 : string, Authentication method to use                                  </P
7811 ></LI
7812 ></UL
7813 ></LI
7814 ><LI
7815 ><P
7816 >&#13;                          <CODE
7817 CLASS="parameter"
7818 >role_id_or_name</CODE
7819 >
7820 : int or string                 </P
7821 ><P
7822 ></P
7823 ><UL
7824 ><LI
7825 ><P
7826 >&#13;int, Role identifier                                      </P
7827 ></LI
7828 ><LI
7829 ><P
7830 >&#13;string, Role                                      </P
7831 ></LI
7832 ></UL
7833 ></LI
7834 ><LI
7835 ><P
7836 >&#13;                          <CODE
7837 CLASS="parameter"
7838 >person_id_or_email</CODE
7839 >
7840 : int or string                 </P
7841 ><P
7842 ></P
7843 ><UL
7844 ><LI
7845 ><P
7846 >&#13;int, User identifier                                      </P
7847 ></LI
7848 ><LI
7849 ><P
7850 >&#13;string, Primary e-mail address                                    </P
7851 ></LI
7852 ></UL
7853 ></LI
7854 ></UL
7855 ><P
7856 >Returns:</P
7857 ><P
7858 ></P
7859 ><UL
7860 ><LI
7861 ><P
7862 >&#13;int, 1 if successful                      </P
7863 ></LI
7864 ></UL
7865 ></DIV
7866 ><DIV
7867 CLASS="section"
7868 ><HR><H2
7869 CLASS="section"
7870 ><A
7871 NAME="DeleteRole"
7872 >2.59. DeleteRole</A
7873 ></H2
7874 ><P
7875 >Prototype:<A
7876 NAME="AEN2415"
7877 ></A
7878 ><BLOCKQUOTE
7879 CLASS="BLOCKQUOTE"
7880 ><P
7881 >DeleteRole (auth, role_id_or_name)</P
7882 ></BLOCKQUOTE
7883 ></P
7884 ><P
7885 >Description:<A
7886 NAME="AEN2418"
7887 ></A
7888 ><BLOCKQUOTE
7889 CLASS="BLOCKQUOTE"
7890 ><P
7891 >Deletes a role.</P
7892 ><P
7893 >WARNING: This will remove the specified role from all accounts
7894 that possess it, and from all node and slice attributes that refer
7895 to it.</P
7896 ><P
7897 >Returns 1 if successful, faults otherwise.</P
7898 ></BLOCKQUOTE
7899 ></P
7900 ><P
7901 >Allowed Roles:<A
7902 NAME="AEN2423"
7903 ></A
7904 ><BLOCKQUOTE
7905 CLASS="BLOCKQUOTE"
7906 ><P
7907 >admin</P
7908 ></BLOCKQUOTE
7909 ></P
7910 ><P
7911 >Parameters:</P
7912 ><P
7913 ></P
7914 ><UL
7915 ><LI
7916 ><P
7917 >&#13;                          <CODE
7918 CLASS="parameter"
7919 >auth</CODE
7920 >
7921 : struct, API authentication structure                  </P
7922 ><P
7923 ></P
7924 ><UL
7925 ><LI
7926 ><P
7927 >&#13;                                          <CODE
7928 CLASS="parameter"
7929 >AuthMethod</CODE
7930 >
7931 : string, Authentication method to use                                  </P
7932 ></LI
7933 ></UL
7934 ></LI
7935 ><LI
7936 ><P
7937 >&#13;                          <CODE
7938 CLASS="parameter"
7939 >role_id_or_name</CODE
7940 >
7941 : int or string                 </P
7942 ><P
7943 ></P
7944 ><UL
7945 ><LI
7946 ><P
7947 >&#13;int, Role identifier                                      </P
7948 ></LI
7949 ><LI
7950 ><P
7951 >&#13;string, Role                                      </P
7952 ></LI
7953 ></UL
7954 ></LI
7955 ></UL
7956 ><P
7957 >Returns:</P
7958 ><P
7959 ></P
7960 ><UL
7961 ><LI
7962 ><P
7963 >&#13;int, 1 if successful                      </P
7964 ></LI
7965 ></UL
7966 ></DIV
7967 ><DIV
7968 CLASS="section"
7969 ><HR><H2
7970 CLASS="section"
7971 ><A
7972 NAME="DeleteSession"
7973 >2.60. DeleteSession</A
7974 ></H2
7975 ><P
7976 >Prototype:<A
7977 NAME="AEN2449"
7978 ></A
7979 ><BLOCKQUOTE
7980 CLASS="BLOCKQUOTE"
7981 ><P
7982 >DeleteSession (auth)</P
7983 ></BLOCKQUOTE
7984 ></P
7985 ><P
7986 >Description:<A
7987 NAME="AEN2452"
7988 ></A
7989 ><BLOCKQUOTE
7990 CLASS="BLOCKQUOTE"
7991 ><P
7992 >Invalidates the current session.</P
7993 ><P
7994 >Returns 1 if successful.</P
7995 ></BLOCKQUOTE
7996 ></P
7997 ><P
7998 >Allowed Roles:<A
7999 NAME="AEN2456"
8000 ></A
8001 ><BLOCKQUOTE
8002 CLASS="BLOCKQUOTE"
8003 ><P
8004 >admin, pi, user, tech, node</P
8005 ></BLOCKQUOTE
8006 ></P
8007 ><P
8008 >Parameters:</P
8009 ><P
8010 ></P
8011 ><UL
8012 ><LI
8013 ><P
8014 >&#13;                          <CODE
8015 CLASS="parameter"
8016 >auth</CODE
8017 >
8018 : struct, API authentication structure                  </P
8019 ><P
8020 ></P
8021 ><UL
8022 ><LI
8023 ><P
8024 >&#13;                                          <CODE
8025 CLASS="parameter"
8026 >session</CODE
8027 >
8028 : string, Session key                                   </P
8029 ></LI
8030 ><LI
8031 ><P
8032 >&#13;                                          <CODE
8033 CLASS="parameter"
8034 >AuthMethod</CODE
8035 >
8036 : string, Authentication method to use, always 'session'                                        </P
8037 ></LI
8038 ></UL
8039 ></LI
8040 ></UL
8041 ><P
8042 >Returns:</P
8043 ><P
8044 ></P
8045 ><UL
8046 ><LI
8047 ><P
8048 >&#13;int, 1 if successful                      </P
8049 ></LI
8050 ></UL
8051 ></DIV
8052 ><DIV
8053 CLASS="section"
8054 ><HR><H2
8055 CLASS="section"
8056 ><A
8057 NAME="DeleteSite"
8058 >2.61. DeleteSite</A
8059 ></H2
8060 ><P
8061 >Prototype:<A
8062 NAME="AEN2477"
8063 ></A
8064 ><BLOCKQUOTE
8065 CLASS="BLOCKQUOTE"
8066 ><P
8067 >DeleteSite (auth, site_id_or_login_base)</P
8068 ></BLOCKQUOTE
8069 ></P
8070 ><P
8071 >Description:<A
8072 NAME="AEN2480"
8073 ></A
8074 ><BLOCKQUOTE
8075 CLASS="BLOCKQUOTE"
8076 ><P
8077 >Mark an existing site as deleted. The accounts of people who are
8078 not members of at least one other non-deleted site will also be
8079 marked as deleted. Nodes, PCUs, and slices associated with the
8080 site will be deleted.</P
8081 ><P
8082 >Returns 1 if successful, faults otherwise.</P
8083 ></BLOCKQUOTE
8084 ></P
8085 ><P
8086 >Allowed Roles:<A
8087 NAME="AEN2484"
8088 ></A
8089 ><BLOCKQUOTE
8090 CLASS="BLOCKQUOTE"
8091 ><P
8092 >admin</P
8093 ></BLOCKQUOTE
8094 ></P
8095 ><P
8096 >Parameters:</P
8097 ><P
8098 ></P
8099 ><UL
8100 ><LI
8101 ><P
8102 >&#13;                          <CODE
8103 CLASS="parameter"
8104 >auth</CODE
8105 >
8106 : struct, API authentication structure                  </P
8107 ><P
8108 ></P
8109 ><UL
8110 ><LI
8111 ><P
8112 >&#13;                                          <CODE
8113 CLASS="parameter"
8114 >AuthMethod</CODE
8115 >
8116 : string, Authentication method to use                                  </P
8117 ></LI
8118 ></UL
8119 ></LI
8120 ><LI
8121 ><P
8122 >&#13;                          <CODE
8123 CLASS="parameter"
8124 >site_id_or_login_base</CODE
8125 >
8126 : int or string                 </P
8127 ><P
8128 ></P
8129 ><UL
8130 ><LI
8131 ><P
8132 >&#13;int, Site identifier                                      </P
8133 ></LI
8134 ><LI
8135 ><P
8136 >&#13;string, Site slice prefix                                 </P
8137 ></LI
8138 ></UL
8139 ></LI
8140 ></UL
8141 ><P
8142 >Returns:</P
8143 ><P
8144 ></P
8145 ><UL
8146 ><LI
8147 ><P
8148 >&#13;int, 1 if successful                      </P
8149 ></LI
8150 ></UL
8151 ></DIV
8152 ><DIV
8153 CLASS="section"
8154 ><HR><H2
8155 CLASS="section"
8156 ><A
8157 NAME="DeleteSliceAttribute"
8158 >2.62. DeleteSliceAttribute</A
8159 ></H2
8160 ><P
8161 >Prototype:<A
8162 NAME="AEN2510"
8163 ></A
8164 ><BLOCKQUOTE
8165 CLASS="BLOCKQUOTE"
8166 ><P
8167 >DeleteSliceAttribute (auth, slice_attribute_id)</P
8168 ></BLOCKQUOTE
8169 ></P
8170 ><P
8171 >Description:<A
8172 NAME="AEN2513"
8173 ></A
8174 ><BLOCKQUOTE
8175 CLASS="BLOCKQUOTE"
8176 ><P
8177 >Deletes the specified slice or sliver attribute.</P
8178 ><P
8179 >Attributes may require the caller to have a particular role in
8180 order to be deleted. Users may only delete attributes of
8181 slices or slivers of which they are members. PIs may only delete
8182 attributes of slices or slivers at their sites, or of which they
8183 are members. Admins may delete attributes of any slice or sliver.</P
8184 ><P
8185 >Returns 1 if successful, faults otherwise.</P
8186 ></BLOCKQUOTE
8187 ></P
8188 ><P
8189 >Allowed Roles:<A
8190 NAME="AEN2518"
8191 ></A
8192 ><BLOCKQUOTE
8193 CLASS="BLOCKQUOTE"
8194 ><P
8195 >admin, pi, user</P
8196 ></BLOCKQUOTE
8197 ></P
8198 ><P
8199 >Parameters:</P
8200 ><P
8201 ></P
8202 ><UL
8203 ><LI
8204 ><P
8205 >&#13;                          <CODE
8206 CLASS="parameter"
8207 >auth</CODE
8208 >
8209 : struct, API authentication structure                  </P
8210 ><P
8211 ></P
8212 ><UL
8213 ><LI
8214 ><P
8215 >&#13;                                          <CODE
8216 CLASS="parameter"
8217 >AuthMethod</CODE
8218 >
8219 : string, Authentication method to use                                  </P
8220 ></LI
8221 ></UL
8222 ></LI
8223 ><LI
8224 ><P
8225 >&#13;                          <CODE
8226 CLASS="parameter"
8227 >slice_attribute_id</CODE
8228 >
8229 : int, Slice attribute identifier                       </P
8230 ></LI
8231 ></UL
8232 ><P
8233 >Returns:</P
8234 ><P
8235 ></P
8236 ><UL
8237 ><LI
8238 ><P
8239 >&#13;int, 1 if successful                      </P
8240 ></LI
8241 ></UL
8242 ></DIV
8243 ><DIV
8244 CLASS="section"
8245 ><HR><H2
8246 CLASS="section"
8247 ><A
8248 NAME="DeleteSliceAttributeType"
8249 >2.63. DeleteSliceAttributeType</A
8250 ></H2
8251 ><P
8252 >Prototype:<A
8253 NAME="AEN2539"
8254 ></A
8255 ><BLOCKQUOTE
8256 CLASS="BLOCKQUOTE"
8257 ><P
8258 >DeleteSliceAttributeType (auth, attribute_type_id_or_name)</P
8259 ></BLOCKQUOTE
8260 ></P
8261 ><P
8262 >Description:<A
8263 NAME="AEN2542"
8264 ></A
8265 ><BLOCKQUOTE
8266 CLASS="BLOCKQUOTE"
8267 ><P
8268 >Deletes the specified slice attribute.</P
8269 ><P
8270 >Returns 1 if successful, faults otherwise.</P
8271 ></BLOCKQUOTE
8272 ></P
8273 ><P
8274 >Allowed Roles:<A
8275 NAME="AEN2546"
8276 ></A
8277 ><BLOCKQUOTE
8278 CLASS="BLOCKQUOTE"
8279 ><P
8280 >admin</P
8281 ></BLOCKQUOTE
8282 ></P
8283 ><P
8284 >Parameters:</P
8285 ><P
8286 ></P
8287 ><UL
8288 ><LI
8289 ><P
8290 >&#13;                          <CODE
8291 CLASS="parameter"
8292 >auth</CODE
8293 >
8294 : struct, API authentication structure                  </P
8295 ><P
8296 ></P
8297 ><UL
8298 ><LI
8299 ><P
8300 >&#13;                                          <CODE
8301 CLASS="parameter"
8302 >AuthMethod</CODE
8303 >
8304 : string, Authentication method to use                                  </P
8305 ></LI
8306 ></UL
8307 ></LI
8308 ><LI
8309 ><P
8310 >&#13;                          <CODE
8311 CLASS="parameter"
8312 >attribute_type_id_or_name</CODE
8313 >
8314 : int or string                 </P
8315 ><P
8316 ></P
8317 ><UL
8318 ><LI
8319 ><P
8320 >&#13;int, Slice attribute type identifier                                      </P
8321 ></LI
8322 ><LI
8323 ><P
8324 >&#13;string, Slice attribute type name                                 </P
8325 ></LI
8326 ></UL
8327 ></LI
8328 ></UL
8329 ><P
8330 >Returns:</P
8331 ><P
8332 ></P
8333 ><UL
8334 ><LI
8335 ><P
8336 >&#13;int, 1 if successful                      </P
8337 ></LI
8338 ></UL
8339 ></DIV
8340 ><DIV
8341 CLASS="section"
8342 ><HR><H2
8343 CLASS="section"
8344 ><A
8345 NAME="DeleteSliceFromNodes"
8346 >2.64. DeleteSliceFromNodes</A
8347 ></H2
8348 ><P
8349 >Prototype:<A
8350 NAME="AEN2572"
8351 ></A
8352 ><BLOCKQUOTE
8353 CLASS="BLOCKQUOTE"
8354 ><P
8355 >DeleteSliceFromNodes (auth, slice_id_or_name, node_id_or_hostname_list)</P
8356 ></BLOCKQUOTE
8357 ></P
8358 ><P
8359 >Description:<A
8360 NAME="AEN2575"
8361 ></A
8362 ><BLOCKQUOTE
8363 CLASS="BLOCKQUOTE"
8364 ><P
8365 >Deletes the specified slice from the specified nodes. If the slice is
8366 not associated with a node, no errors are returned.</P
8367 ><P
8368 >Returns 1 if successful, faults otherwise.</P
8369 ></BLOCKQUOTE
8370 ></P
8371 ><P
8372 >Allowed Roles:<A
8373 NAME="AEN2579"
8374 ></A
8375 ><BLOCKQUOTE
8376 CLASS="BLOCKQUOTE"
8377 ><P
8378 >admin, pi, user</P
8379 ></BLOCKQUOTE
8380 ></P
8381 ><P
8382 >Parameters:</P
8383 ><P
8384 ></P
8385 ><UL
8386 ><LI
8387 ><P
8388 >&#13;                          <CODE
8389 CLASS="parameter"
8390 >auth</CODE
8391 >
8392 : struct, API authentication structure                  </P
8393 ><P
8394 ></P
8395 ><UL
8396 ><LI
8397 ><P
8398 >&#13;                                          <CODE
8399 CLASS="parameter"
8400 >AuthMethod</CODE
8401 >
8402 : string, Authentication method to use                                  </P
8403 ></LI
8404 ></UL
8405 ></LI
8406 ><LI
8407 ><P
8408 >&#13;                          <CODE
8409 CLASS="parameter"
8410 >slice_id_or_name</CODE
8411 >
8412 : int or string                 </P
8413 ><P
8414 ></P
8415 ><UL
8416 ><LI
8417 ><P
8418 >&#13;int, Slice identifier                                     </P
8419 ></LI
8420 ><LI
8421 ><P
8422 >&#13;string, Slice name                                        </P
8423 ></LI
8424 ></UL
8425 ></LI
8426 ><LI
8427 ><P
8428 >&#13;                          <CODE
8429 CLASS="parameter"
8430 >node_id_or_hostname_list</CODE
8431 >
8432 : array of int or string                        </P
8433 ><P
8434 ></P
8435 ><UL
8436 ><LI
8437 ><P
8438 >&#13;int, Node identifier                                      </P
8439 ></LI
8440 ><LI
8441 ><P
8442 >&#13;string, Fully qualified hostname                                  </P
8443 ></LI
8444 ></UL
8445 ></LI
8446 ></UL
8447 ><P
8448 >Returns:</P
8449 ><P
8450 ></P
8451 ><UL
8452 ><LI
8453 ><P
8454 >&#13;int, 1 if successful                      </P
8455 ></LI
8456 ></UL
8457 ></DIV
8458 ><DIV
8459 CLASS="section"
8460 ><HR><H2
8461 CLASS="section"
8462 ><A
8463 NAME="DeleteSliceInstantiation"
8464 >2.65. DeleteSliceInstantiation</A
8465 ></H2
8466 ><P
8467 >Prototype:<A
8468 NAME="AEN2613"
8469 ></A
8470 ><BLOCKQUOTE
8471 CLASS="BLOCKQUOTE"
8472 ><P
8473 >DeleteSliceInstantiation (auth, instantiation)</P
8474 ></BLOCKQUOTE
8475 ></P
8476 ><P
8477 >Description:<A
8478 NAME="AEN2616"
8479 ></A
8480 ><BLOCKQUOTE
8481 CLASS="BLOCKQUOTE"
8482 ><P
8483 >Deletes a slice instantiation state.</P
8484 ><P
8485 >WARNING: This will cause the deletion of all slices of this instantiation.</P
8486 ><P
8487 >Returns 1 if successful, faults otherwise.</P
8488 ></BLOCKQUOTE
8489 ></P
8490 ><P
8491 >Allowed Roles:<A
8492 NAME="AEN2621"
8493 ></A
8494 ><BLOCKQUOTE
8495 CLASS="BLOCKQUOTE"
8496 ><P
8497 >admin</P
8498 ></BLOCKQUOTE
8499 ></P
8500 ><P
8501 >Parameters:</P
8502 ><P
8503 ></P
8504 ><UL
8505 ><LI
8506 ><P
8507 >&#13;                          <CODE
8508 CLASS="parameter"
8509 >auth</CODE
8510 >
8511 : struct, API authentication structure                  </P
8512 ><P
8513 ></P
8514 ><UL
8515 ><LI
8516 ><P
8517 >&#13;                                          <CODE
8518 CLASS="parameter"
8519 >AuthMethod</CODE
8520 >
8521 : string, Authentication method to use                                  </P
8522 ></LI
8523 ></UL
8524 ></LI
8525 ><LI
8526 ><P
8527 >&#13;                          <CODE
8528 CLASS="parameter"
8529 >instantiation</CODE
8530 >
8531 : string, Slice instantiation state                     </P
8532 ></LI
8533 ></UL
8534 ><P
8535 >Returns:</P
8536 ><P
8537 ></P
8538 ><UL
8539 ><LI
8540 ><P
8541 >&#13;int, 1 if successful                      </P
8542 ></LI
8543 ></UL
8544 ></DIV
8545 ><DIV
8546 CLASS="section"
8547 ><HR><H2
8548 CLASS="section"
8549 ><A
8550 NAME="DeleteSlice"
8551 >2.66. DeleteSlice</A
8552 ></H2
8553 ><P
8554 >Prototype:<A
8555 NAME="AEN2642"
8556 ></A
8557 ><BLOCKQUOTE
8558 CLASS="BLOCKQUOTE"
8559 ><P
8560 >DeleteSlice (auth, slice_id_or_name)</P
8561 ></BLOCKQUOTE
8562 ></P
8563 ><P
8564 >Description:<A
8565 NAME="AEN2645"
8566 ></A
8567 ><BLOCKQUOTE
8568 CLASS="BLOCKQUOTE"
8569 ><P
8570 >Deletes the specified slice.</P
8571 ><P
8572 >Users may only delete slices of which they are members. PIs may
8573 delete any of the slices at their sites, or any slices of which
8574 they are members. Admins may delete any slice.</P
8575 ><P
8576 >Returns 1 if successful, faults otherwise.</P
8577 ></BLOCKQUOTE
8578 ></P
8579 ><P
8580 >Allowed Roles:<A
8581 NAME="AEN2650"
8582 ></A
8583 ><BLOCKQUOTE
8584 CLASS="BLOCKQUOTE"
8585 ><P
8586 >admin, pi, user</P
8587 ></BLOCKQUOTE
8588 ></P
8589 ><P
8590 >Parameters:</P
8591 ><P
8592 ></P
8593 ><UL
8594 ><LI
8595 ><P
8596 >&#13;                          <CODE
8597 CLASS="parameter"
8598 >auth</CODE
8599 >
8600 : struct, API authentication structure                  </P
8601 ><P
8602 ></P
8603 ><UL
8604 ><LI
8605 ><P
8606 >&#13;                                          <CODE
8607 CLASS="parameter"
8608 >AuthMethod</CODE
8609 >
8610 : string, Authentication method to use                                  </P
8611 ></LI
8612 ></UL
8613 ></LI
8614 ><LI
8615 ><P
8616 >&#13;                          <CODE
8617 CLASS="parameter"
8618 >slice_id_or_name</CODE
8619 >
8620 : int or string                 </P
8621 ><P
8622 ></P
8623 ><UL
8624 ><LI
8625 ><P
8626 >&#13;int, Slice identifier                                     </P
8627 ></LI
8628 ><LI
8629 ><P
8630 >&#13;string, Slice name                                        </P
8631 ></LI
8632 ></UL
8633 ></LI
8634 ></UL
8635 ><P
8636 >Returns:</P
8637 ><P
8638 ></P
8639 ><UL
8640 ><LI
8641 ><P
8642 >&#13;int, 1 if successful                      </P
8643 ></LI
8644 ></UL
8645 ></DIV
8646 ><DIV
8647 CLASS="section"
8648 ><HR><H2
8649 CLASS="section"
8650 ><A
8651 NAME="GetAddresses"
8652 >2.67. GetAddresses</A
8653 ></H2
8654 ><P
8655 >Prototype:<A
8656 NAME="AEN2676"
8657 ></A
8658 ><BLOCKQUOTE
8659 CLASS="BLOCKQUOTE"
8660 ><P
8661 >GetAddresses (auth, address_filter, return_fields)</P
8662 ></BLOCKQUOTE
8663 ></P
8664 ><P
8665 >Description:<A
8666 NAME="AEN2679"
8667 ></A
8668 ><BLOCKQUOTE
8669 CLASS="BLOCKQUOTE"
8670 ><P
8671 >Returns an array of structs containing details about addresses. If
8672 address_filter is specified and is an array of address
8673 identifiers, or a struct of address attributes, only addresses
8674 matching the filter will be returned. If return_fields is
8675 specified, only the specified details will be returned.</P
8676 ></BLOCKQUOTE
8677 ></P
8678 ><P
8679 >Allowed Roles:<A
8680 NAME="AEN2682"
8681 ></A
8682 ><BLOCKQUOTE
8683 CLASS="BLOCKQUOTE"
8684 ><P
8685 >admin, pi, user, tech, node</P
8686 ></BLOCKQUOTE
8687 ></P
8688 ><P
8689 >Parameters:</P
8690 ><P
8691 ></P
8692 ><UL
8693 ><LI
8694 ><P
8695 >&#13;                          <CODE
8696 CLASS="parameter"
8697 >auth</CODE
8698 >
8699 : struct, API authentication structure                  </P
8700 ><P
8701 ></P
8702 ><UL
8703 ><LI
8704 ><P
8705 >&#13;                                          <CODE
8706 CLASS="parameter"
8707 >AuthMethod</CODE
8708 >
8709 : string, Authentication method to use                                  </P
8710 ></LI
8711 ></UL
8712 ></LI
8713 ><LI
8714 ><P
8715 >&#13;                          <CODE
8716 CLASS="parameter"
8717 >address_filter</CODE
8718 >
8719 : array of int or struct                        </P
8720 ><P
8721 ></P
8722 ><UL
8723 ><LI
8724 ><P
8725 >&#13;array of int, Address identifier                                  </P
8726 ></LI
8727 ><LI
8728 ><P
8729 >&#13;struct, Attribute filter                                  </P
8730 ><P
8731 ></P
8732 ><UL
8733 ><LI
8734 ><P
8735 >&#13;                                                          <CODE
8736 CLASS="parameter"
8737 >city</CODE
8738 >
8739 : string or array of string                                                     </P
8740 ><P
8741 ></P
8742 ><UL
8743 ><LI
8744 ><P
8745 >&#13;string, City                                                                      </P
8746 ></LI
8747 ><LI
8748 ><P
8749 >&#13;array of string, City                                                                     </P
8750 ></LI
8751 ></UL
8752 ></LI
8753 ><LI
8754 ><P
8755 >&#13;                                                          <CODE
8756 CLASS="parameter"
8757 >address_id</CODE
8758 >
8759 : int or array of int                                                   </P
8760 ><P
8761 ></P
8762 ><UL
8763 ><LI
8764 ><P
8765 >&#13;int, Address identifier                                                                   </P
8766 ></LI
8767 ><LI
8768 ><P
8769 >&#13;array of int, Address identifier                                                                  </P
8770 ></LI
8771 ></UL
8772 ></LI
8773 ><LI
8774 ><P
8775 >&#13;                                                          <CODE
8776 CLASS="parameter"
8777 >country</CODE
8778 >
8779 : string or array of string                                                     </P
8780 ><P
8781 ></P
8782 ><UL
8783 ><LI
8784 ><P
8785 >&#13;string, Country                                                                   </P
8786 ></LI
8787 ><LI
8788 ><P
8789 >&#13;array of string, Country                                                                  </P
8790 ></LI
8791 ></UL
8792 ></LI
8793 ><LI
8794 ><P
8795 >&#13;                                                          <CODE
8796 CLASS="parameter"
8797 >line3</CODE
8798 >
8799 : string or array of string                                                     </P
8800 ><P
8801 ></P
8802 ><UL
8803 ><LI
8804 ><P
8805 >&#13;string, Address line 3                                                                    </P
8806 ></LI
8807 ><LI
8808 ><P
8809 >&#13;array of string, Address line 3                                                                   </P
8810 ></LI
8811 ></UL
8812 ></LI
8813 ><LI
8814 ><P
8815 >&#13;                                                          <CODE
8816 CLASS="parameter"
8817 >line2</CODE
8818 >
8819 : string or array of string                                                     </P
8820 ><P
8821 ></P
8822 ><UL
8823 ><LI
8824 ><P
8825 >&#13;string, Address line 2                                                                    </P
8826 ></LI
8827 ><LI
8828 ><P
8829 >&#13;array of string, Address line 2                                                                   </P
8830 ></LI
8831 ></UL
8832 ></LI
8833 ><LI
8834 ><P
8835 >&#13;                                                          <CODE
8836 CLASS="parameter"
8837 >line1</CODE
8838 >
8839 : string or array of string                                                     </P
8840 ><P
8841 ></P
8842 ><UL
8843 ><LI
8844 ><P
8845 >&#13;string, Address line 1                                                                    </P
8846 ></LI
8847 ><LI
8848 ><P
8849 >&#13;array of string, Address line 1                                                                   </P
8850 ></LI
8851 ></UL
8852 ></LI
8853 ><LI
8854 ><P
8855 >&#13;                                                          <CODE
8856 CLASS="parameter"
8857 >state</CODE
8858 >
8859 : string or array of string                                                     </P
8860 ><P
8861 ></P
8862 ><UL
8863 ><LI
8864 ><P
8865 >&#13;string, State or province                                                                 </P
8866 ></LI
8867 ><LI
8868 ><P
8869 >&#13;array of string, State or province                                                                        </P
8870 ></LI
8871 ></UL
8872 ></LI
8873 ><LI
8874 ><P
8875 >&#13;                                                          <CODE
8876 CLASS="parameter"
8877 >postalcode</CODE
8878 >
8879 : string or array of string                                                     </P
8880 ><P
8881 ></P
8882 ><UL
8883 ><LI
8884 ><P
8885 >&#13;string, Postal code                                                                       </P
8886 ></LI
8887 ><LI
8888 ><P
8889 >&#13;array of string, Postal code                                                                      </P
8890 ></LI
8891 ></UL
8892 ></LI
8893 ></UL
8894 ></LI
8895 ></UL
8896 ></LI
8897 ><LI
8898 ><P
8899 >&#13;                          <CODE
8900 CLASS="parameter"
8901 >return_fields</CODE
8902 >
8903 : array, List of fields to return                       </P
8904 ><P
8905 ></P
8906 ><UL
8907 ><LI
8908 ><P
8909 >&#13;string                                    </P
8910 ></LI
8911 ></UL
8912 ></LI
8913 ></UL
8914 ><P
8915 >Returns:</P
8916 ><P
8917 ></P
8918 ><UL
8919 ><LI
8920 ><P
8921 >&#13;array of struct                   </P
8922 ><P
8923 ></P
8924 ><UL
8925 ><LI
8926 ><P
8927 >&#13;                                          <CODE
8928 CLASS="parameter"
8929 >city</CODE
8930 >
8931 : string, City                                  </P
8932 ></LI
8933 ><LI
8934 ><P
8935 >&#13;                                          <CODE
8936 CLASS="parameter"
8937 >address_id</CODE
8938 >
8939 : int, Address identifier                                       </P
8940 ></LI
8941 ><LI
8942 ><P
8943 >&#13;                                          <CODE
8944 CLASS="parameter"
8945 >country</CODE
8946 >
8947 : string, Country                                       </P
8948 ></LI
8949 ><LI
8950 ><P
8951 >&#13;                                          <CODE
8952 CLASS="parameter"
8953 >line3</CODE
8954 >
8955 : string, Address line 3                                        </P
8956 ></LI
8957 ><LI
8958 ><P
8959 >&#13;                                          <CODE
8960 CLASS="parameter"
8961 >line2</CODE
8962 >
8963 : string, Address line 2                                        </P
8964 ></LI
8965 ><LI
8966 ><P
8967 >&#13;                                          <CODE
8968 CLASS="parameter"
8969 >line1</CODE
8970 >
8971 : string, Address line 1                                        </P
8972 ></LI
8973 ><LI
8974 ><P
8975 >&#13;                                          <CODE
8976 CLASS="parameter"
8977 >address_type_ids</CODE
8978 >
8979 : array, Address type identifiers                                       </P
8980 ><P
8981 ></P
8982 ><UL
8983 ><LI
8984 ><P
8985 >&#13;int                                                       </P
8986 ></LI
8987 ></UL
8988 ></LI
8989 ><LI
8990 ><P
8991 >&#13;                                          <CODE
8992 CLASS="parameter"
8993 >state</CODE
8994 >
8995 : string, State or province                                     </P
8996 ></LI
8997 ><LI
8998 ><P
8999 >&#13;                                          <CODE
9000 CLASS="parameter"
9001 >postalcode</CODE
9002 >
9003 : string, Postal code                                   </P
9004 ></LI
9005 ><LI
9006 ><P
9007 >&#13;                                          <CODE
9008 CLASS="parameter"
9009 >address_types</CODE
9010 >
9011 : array, Address types                                  </P
9012 ><P
9013 ></P
9014 ><UL
9015 ><LI
9016 ><P
9017 >&#13;string                                                    </P
9018 ></LI
9019 ></UL
9020 ></LI
9021 ></UL
9022 ></LI
9023 ></UL
9024 ></DIV
9025 ><DIV
9026 CLASS="section"
9027 ><HR><H2
9028 CLASS="section"
9029 ><A
9030 NAME="GetAddressTypes"
9031 >2.68. GetAddressTypes</A
9032 ></H2
9033 ><P
9034 >Prototype:<A
9035 NAME="AEN2816"
9036 ></A
9037 ><BLOCKQUOTE
9038 CLASS="BLOCKQUOTE"
9039 ><P
9040 >GetAddressTypes (auth, address_type_filter, return_fields)</P
9041 ></BLOCKQUOTE
9042 ></P
9043 ><P
9044 >Description:<A
9045 NAME="AEN2819"
9046 ></A
9047 ><BLOCKQUOTE
9048 CLASS="BLOCKQUOTE"
9049 ><P
9050 >Returns an array of structs containing details about address
9051 types. If address_type_filter is specified and is an array of
9052 address type identifiers, or a struct of address type attributes,
9053 only address types matching the filter will be returned. If
9054 return_fields is specified, only the specified details will be
9055 returned.</P
9056 ></BLOCKQUOTE
9057 ></P
9058 ><P
9059 >Allowed Roles:<A
9060 NAME="AEN2822"
9061 ></A
9062 ><BLOCKQUOTE
9063 CLASS="BLOCKQUOTE"
9064 ><P
9065 >admin, pi, user, tech, node</P
9066 ></BLOCKQUOTE
9067 ></P
9068 ><P
9069 >Parameters:</P
9070 ><P
9071 ></P
9072 ><UL
9073 ><LI
9074 ><P
9075 >&#13;                          <CODE
9076 CLASS="parameter"
9077 >auth</CODE
9078 >
9079 : struct, API authentication structure                  </P
9080 ><P
9081 ></P
9082 ><UL
9083 ><LI
9084 ><P
9085 >&#13;                                          <CODE
9086 CLASS="parameter"
9087 >AuthMethod</CODE
9088 >
9089 : string, Authentication method to use                                  </P
9090 ></LI
9091 ></UL
9092 ></LI
9093 ><LI
9094 ><P
9095 >&#13;                          <CODE
9096 CLASS="parameter"
9097 >address_type_filter</CODE
9098 >
9099 : array of int or string or struct                      </P
9100 ><P
9101 ></P
9102 ><UL
9103 ><LI
9104 ><P
9105 >&#13;array of int or string                                    </P
9106 ><P
9107 ></P
9108 ><UL
9109 ><LI
9110 ><P
9111 >&#13;int, Address type identifier                                                      </P
9112 ></LI
9113 ><LI
9114 ><P
9115 >&#13;string, Address type                                                      </P
9116 ></LI
9117 ></UL
9118 ></LI
9119 ><LI
9120 ><P
9121 >&#13;struct, Attribute filter                                  </P
9122 ><P
9123 ></P
9124 ><UL
9125 ><LI
9126 ><P
9127 >&#13;                                                          <CODE
9128 CLASS="parameter"
9129 >name</CODE
9130 >
9131 : string or array of string                                                     </P
9132 ><P
9133 ></P
9134 ><UL
9135 ><LI
9136 ><P
9137 >&#13;string, Address type                                                                      </P
9138 ></LI
9139 ><LI
9140 ><P
9141 >&#13;array of string, Address type                                                                     </P
9142 ></LI
9143 ></UL
9144 ></LI
9145 ><LI
9146 ><P
9147 >&#13;                                                          <CODE
9148 CLASS="parameter"
9149 >address_type_id</CODE
9150 >
9151 : int or array of int                                                   </P
9152 ><P
9153 ></P
9154 ><UL
9155 ><LI
9156 ><P
9157 >&#13;int, Address type identifier                                                                      </P
9158 ></LI
9159 ><LI
9160 ><P
9161 >&#13;array of int, Address type identifier                                                                     </P
9162 ></LI
9163 ></UL
9164 ></LI
9165 ><LI
9166 ><P
9167 >&#13;                                                          <CODE
9168 CLASS="parameter"
9169 >description</CODE
9170 >
9171 : string or array of string                                                     </P
9172 ><P
9173 ></P
9174 ><UL
9175 ><LI
9176 ><P
9177 >&#13;string, Address type description                                                                  </P
9178 ></LI
9179 ><LI
9180 ><P
9181 >&#13;array of string, Address type description                                                                 </P
9182 ></LI
9183 ></UL
9184 ></LI
9185 ></UL
9186 ></LI
9187 ></UL
9188 ></LI
9189 ><LI
9190 ><P
9191 >&#13;                          <CODE
9192 CLASS="parameter"
9193 >return_fields</CODE
9194 >
9195 : array, List of fields to return                       </P
9196 ><P
9197 ></P
9198 ><UL
9199 ><LI
9200 ><P
9201 >&#13;string                                    </P
9202 ></LI
9203 ></UL
9204 ></LI
9205 ></UL
9206 ><P
9207 >Returns:</P
9208 ><P
9209 ></P
9210 ><UL
9211 ><LI
9212 ><P
9213 >&#13;array of struct                   </P
9214 ><P
9215 ></P
9216 ><UL
9217 ><LI
9218 ><P
9219 >&#13;                                          <CODE
9220 CLASS="parameter"
9221 >name</CODE
9222 >
9223 : string, Address type                                  </P
9224 ></LI
9225 ><LI
9226 ><P
9227 >&#13;                                          <CODE
9228 CLASS="parameter"
9229 >address_type_id</CODE
9230 >
9231 : int, Address type identifier                                  </P
9232 ></LI
9233 ><LI
9234 ><P
9235 >&#13;                                          <CODE
9236 CLASS="parameter"
9237 >description</CODE
9238 >
9239 : string, Address type description                                      </P
9240 ></LI
9241 ></UL
9242 ></LI
9243 ></UL
9244 ></DIV
9245 ><DIV
9246 CLASS="section"
9247 ><HR><H2
9248 CLASS="section"
9249 ><A
9250 NAME="GetBootStates"
9251 >2.69. GetBootStates</A
9252 ></H2
9253 ><P
9254 >Prototype:<A
9255 NAME="AEN2894"
9256 ></A
9257 ><BLOCKQUOTE
9258 CLASS="BLOCKQUOTE"
9259 ><P
9260 >GetBootStates (auth)</P
9261 ></BLOCKQUOTE
9262 ></P
9263 ><P
9264 >Description:<A
9265 NAME="AEN2897"
9266 ></A
9267 ><BLOCKQUOTE
9268 CLASS="BLOCKQUOTE"
9269 ><P
9270 >Returns an array of all valid node boot states.</P
9271 ></BLOCKQUOTE
9272 ></P
9273 ><P
9274 >Allowed Roles:<A
9275 NAME="AEN2900"
9276 ></A
9277 ><BLOCKQUOTE
9278 CLASS="BLOCKQUOTE"
9279 ><P
9280 >admin, pi, user, tech, node</P
9281 ></BLOCKQUOTE
9282 ></P
9283 ><P
9284 >Parameters:</P
9285 ><P
9286 ></P
9287 ><UL
9288 ><LI
9289 ><P
9290 >&#13;                          <CODE
9291 CLASS="parameter"
9292 >auth</CODE
9293 >
9294 : struct, API authentication structure                  </P
9295 ><P
9296 ></P
9297 ><UL
9298 ><LI
9299 ><P
9300 >&#13;                                          <CODE
9301 CLASS="parameter"
9302 >AuthMethod</CODE
9303 >
9304 : string, Authentication method to use                                  </P
9305 ></LI
9306 ></UL
9307 ></LI
9308 ></UL
9309 ><P
9310 >Returns:</P
9311 ><P
9312 ></P
9313 ><UL
9314 ><LI
9315 ><P
9316 >&#13;array of string, Boot state                       </P
9317 ></LI
9318 ></UL
9319 ></DIV
9320 ><DIV
9321 CLASS="section"
9322 ><HR><H2
9323 CLASS="section"
9324 ><A
9325 NAME="GetConfFiles"
9326 >2.70. GetConfFiles</A
9327 ></H2
9328 ><P
9329 >Prototype:<A
9330 NAME="AEN2918"
9331 ></A
9332 ><BLOCKQUOTE
9333 CLASS="BLOCKQUOTE"
9334 ><P
9335 >GetConfFiles (auth, conf_file_filter, return_fields)</P
9336 ></BLOCKQUOTE
9337 ></P
9338 ><P
9339 >Description:<A
9340 NAME="AEN2921"
9341 ></A
9342 ><BLOCKQUOTE
9343 CLASS="BLOCKQUOTE"
9344 ><P
9345 >Returns an array of structs containing details about configuration
9346 files. If conf_file_filter is specified and is an array of
9347 configuration file identifiers, or a struct of configuration file
9348 attributes, only configuration files matching the filter will be
9349 returned. If return_fields is specified, only the specified
9350 details will be returned.</P
9351 ></BLOCKQUOTE
9352 ></P
9353 ><P
9354 >Allowed Roles:<A
9355 NAME="AEN2924"
9356 ></A
9357 ><BLOCKQUOTE
9358 CLASS="BLOCKQUOTE"
9359 ><P
9360 >admin, node</P
9361 ></BLOCKQUOTE
9362 ></P
9363 ><P
9364 >Parameters:</P
9365 ><P
9366 ></P
9367 ><UL
9368 ><LI
9369 ><P
9370 >&#13;                          <CODE
9371 CLASS="parameter"
9372 >auth</CODE
9373 >
9374 : struct, API authentication structure                  </P
9375 ><P
9376 ></P
9377 ><UL
9378 ><LI
9379 ><P
9380 >&#13;                                          <CODE
9381 CLASS="parameter"
9382 >AuthMethod</CODE
9383 >
9384 : string, Authentication method to use                                  </P
9385 ></LI
9386 ></UL
9387 ></LI
9388 ><LI
9389 ><P
9390 >&#13;                          <CODE
9391 CLASS="parameter"
9392 >conf_file_filter</CODE
9393 >
9394 : array of int or struct                        </P
9395 ><P
9396 ></P
9397 ><UL
9398 ><LI
9399 ><P
9400 >&#13;array of int, Configuration file identifier                                       </P
9401 ></LI
9402 ><LI
9403 ><P
9404 >&#13;struct, Attribute filter                                  </P
9405 ><P
9406 ></P
9407 ><UL
9408 ><LI
9409 ><P
9410 >&#13;                                                          <CODE
9411 CLASS="parameter"
9412 >file_owner</CODE
9413 >
9414 : string or array of string                                                     </P
9415 ><P
9416 ></P
9417 ><UL
9418 ><LI
9419 ><P
9420 >&#13;string, chown(1) owner                                                                    </P
9421 ></LI
9422 ><LI
9423 ><P
9424 >&#13;array of string, chown(1) owner                                                                   </P
9425 ></LI
9426 ></UL
9427 ></LI
9428 ><LI
9429 ><P
9430 >&#13;                                                          <CODE
9431 CLASS="parameter"
9432 >postinstall_cmd</CODE
9433 >
9434 : string or array of string                                                     </P
9435 ><P
9436 ></P
9437 ><UL
9438 ><LI
9439 ><P
9440 >&#13;string, Shell command to execute after installing                                                                 </P
9441 ></LI
9442 ><LI
9443 ><P
9444 >&#13;array of string, Shell command to execute after installing                                                                        </P
9445 ></LI
9446 ></UL
9447 ></LI
9448 ><LI
9449 ><P
9450 >&#13;                                                          <CODE
9451 CLASS="parameter"
9452 >error_cmd</CODE
9453 >
9454 : string or array of string                                                     </P
9455 ><P
9456 ></P
9457 ><UL
9458 ><LI
9459 ><P
9460 >&#13;string, Shell command to execute if any error occurs                                                                      </P
9461 ></LI
9462 ><LI
9463 ><P
9464 >&#13;array of string, Shell command to execute if any error occurs                                                                     </P
9465 ></LI
9466 ></UL
9467 ></LI
9468 ><LI
9469 ><P
9470 >&#13;                                                          <CODE
9471 CLASS="parameter"
9472 >preinstall_cmd</CODE
9473 >
9474 : string or array of string                                                     </P
9475 ><P
9476 ></P
9477 ><UL
9478 ><LI
9479 ><P
9480 >&#13;string, Shell command to execute prior to installing                                                                      </P
9481 ></LI
9482 ><LI
9483 ><P
9484 >&#13;array of string, Shell command to execute prior to installing                                                                     </P
9485 ></LI
9486 ></UL
9487 ></LI
9488 ><LI
9489 ><P
9490 >&#13;                                                          <CODE
9491 CLASS="parameter"
9492 >node_ids</CODE
9493 >
9494 : int or array of int                                                   </P
9495 ><P
9496 ></P
9497 ><UL
9498 ><LI
9499 ><P
9500 >&#13;int, List of nodes linked to this file                                                                    </P
9501 ></LI
9502 ><LI
9503 ><P
9504 >&#13;array of int, List of nodes linked to this file                                                                   </P
9505 ></LI
9506 ></UL
9507 ></LI
9508 ><LI
9509 ><P
9510 >&#13;                                                          <CODE
9511 CLASS="parameter"
9512 >dest</CODE
9513 >
9514 : string or array of string                                                     </P
9515 ><P
9516 ></P
9517 ><UL
9518 ><LI
9519 ><P
9520 >&#13;string, Absolute path where file should be installed                                                                      </P
9521 ></LI
9522 ><LI
9523 ><P
9524 >&#13;array of string, Absolute path where file should be installed                                                                     </P
9525 ></LI
9526 ></UL
9527 ></LI
9528 ><LI
9529 ><P
9530 >&#13;                                                          <CODE
9531 CLASS="parameter"
9532 >ignore_cmd_errors</CODE
9533 >
9534 : boolean or array of boolean                                                   </P
9535 ><P
9536 ></P
9537 ><UL
9538 ><LI
9539 ><P
9540 >&#13;boolean, Install file anyway even if an error occurs                                                                      </P
9541 ></LI
9542 ><LI
9543 ><P
9544 >&#13;array of boolean, Install file anyway even if an error occurs                                                                     </P
9545 ></LI
9546 ></UL
9547 ></LI
9548 ><LI
9549 ><P
9550 >&#13;                                                          <CODE
9551 CLASS="parameter"
9552 >enabled</CODE
9553 >
9554 : boolean or array of boolean                                                   </P
9555 ><P
9556 ></P
9557 ><UL
9558 ><LI
9559 ><P
9560 >&#13;boolean, Configuration file is active                                                                     </P
9561 ></LI
9562 ><LI
9563 ><P
9564 >&#13;array of boolean, Configuration file is active                                                                    </P
9565 ></LI
9566 ></UL
9567 ></LI
9568 ><LI
9569 ><P
9570 >&#13;                                                          <CODE
9571 CLASS="parameter"
9572 >conf_file_id</CODE
9573 >
9574 : int or array of int                                                   </P
9575 ><P
9576 ></P
9577 ><UL
9578 ><LI
9579 ><P
9580 >&#13;int, Configuration file identifier                                                                        </P
9581 ></LI
9582 ><LI
9583 ><P
9584 >&#13;array of int, Configuration file identifier                                                                       </P
9585 ></LI
9586 ></UL
9587 ></LI
9588 ><LI
9589 ><P
9590 >&#13;                                                          <CODE
9591 CLASS="parameter"
9592 >file_permissions</CODE
9593 >
9594 : string or array of string                                                     </P
9595 ><P
9596 ></P
9597 ><UL
9598 ><LI
9599 ><P
9600 >&#13;string, chmod(1) permissions                                                                      </P
9601 ></LI
9602 ><LI
9603 ><P
9604 >&#13;array of string, chmod(1) permissions                                                                     </P
9605 ></LI
9606 ></UL
9607 ></LI
9608 ><LI
9609 ><P
9610 >&#13;                                                          <CODE
9611 CLASS="parameter"
9612 >source</CODE
9613 >
9614 : string or array of string                                                     </P
9615 ><P
9616 ></P
9617 ><UL
9618 ><LI
9619 ><P
9620 >&#13;string, Relative path on the boot server where file can be downloaded                                                                     </P
9621 ></LI
9622 ><LI
9623 ><P
9624 >&#13;array of string, Relative path on the boot server where file can be downloaded                                                                    </P
9625 ></LI
9626 ></UL
9627 ></LI
9628 ><LI
9629 ><P
9630 >&#13;                                                          <CODE
9631 CLASS="parameter"
9632 >nodegroup_ids</CODE
9633 >
9634 : int or array of int                                                   </P
9635 ><P
9636 ></P
9637 ><UL
9638 ><LI
9639 ><P
9640 >&#13;int, List of node groups linked to this file                                                                      </P
9641 ></LI
9642 ><LI
9643 ><P
9644 >&#13;array of int, List of node groups linked to this file                                                                     </P
9645 ></LI
9646 ></UL
9647 ></LI
9648 ><LI
9649 ><P
9650 >&#13;                                                          <CODE
9651 CLASS="parameter"
9652 >always_update</CODE
9653 >
9654 : boolean or array of boolean                                                   </P
9655 ><P
9656 ></P
9657 ><UL
9658 ><LI
9659 ><P
9660 >&#13;boolean, Always attempt to install file even if unchanged                                                                 </P
9661 ></LI
9662 ><LI
9663 ><P
9664 >&#13;array of boolean, Always attempt to install file even if unchanged                                                                        </P
9665 ></LI
9666 ></UL
9667 ></LI
9668 ><LI
9669 ><P
9670 >&#13;                                                          <CODE
9671 CLASS="parameter"
9672 >file_group</CODE
9673 >
9674 : string or array of string                                                     </P
9675 ><P
9676 ></P
9677 ><UL
9678 ><LI
9679 ><P
9680 >&#13;string, chgrp(1) owner                                                                    </P
9681 ></LI
9682 ><LI
9683 ><P
9684 >&#13;array of string, chgrp(1) owner                                                                   </P
9685 ></LI
9686 ></UL
9687 ></LI
9688 ></UL
9689 ></LI
9690 ></UL
9691 ></LI
9692 ><LI
9693 ><P
9694 >&#13;                          <CODE
9695 CLASS="parameter"
9696 >return_fields</CODE
9697 >
9698 : array, List of fields to return                       </P
9699 ><P
9700 ></P
9701 ><UL
9702 ><LI
9703 ><P
9704 >&#13;string                                    </P
9705 ></LI
9706 ></UL
9707 ></LI
9708 ></UL
9709 ><P
9710 >Returns:</P
9711 ><P
9712 ></P
9713 ><UL
9714 ><LI
9715 ><P
9716 >&#13;array of struct                   </P
9717 ><P
9718 ></P
9719 ><UL
9720 ><LI
9721 ><P
9722 >&#13;                                          <CODE
9723 CLASS="parameter"
9724 >file_owner</CODE
9725 >
9726 : string, chown(1) owner                                        </P
9727 ></LI
9728 ><LI
9729 ><P
9730 >&#13;                                          <CODE
9731 CLASS="parameter"
9732 >postinstall_cmd</CODE
9733 >
9734 : string, Shell command to execute after installing                                     </P
9735 ></LI
9736 ><LI
9737 ><P
9738 >&#13;                                          <CODE
9739 CLASS="parameter"
9740 >error_cmd</CODE
9741 >
9742 : string, Shell command to execute if any error occurs                                  </P
9743 ></LI
9744 ><LI
9745 ><P
9746 >&#13;                                          <CODE
9747 CLASS="parameter"
9748 >preinstall_cmd</CODE
9749 >
9750 : string, Shell command to execute prior to installing                                  </P
9751 ></LI
9752 ><LI
9753 ><P
9754 >&#13;                                          <CODE
9755 CLASS="parameter"
9756 >node_ids</CODE
9757 >
9758 : int, List of nodes linked to this file                                        </P
9759 ></LI
9760 ><LI
9761 ><P
9762 >&#13;                                          <CODE
9763 CLASS="parameter"
9764 >dest</CODE
9765 >
9766 : string, Absolute path where file should be installed                                  </P
9767 ></LI
9768 ><LI
9769 ><P
9770 >&#13;                                          <CODE
9771 CLASS="parameter"
9772 >ignore_cmd_errors</CODE
9773 >
9774 : boolean, Install file anyway even if an error occurs                                  </P
9775 ></LI
9776 ><LI
9777 ><P
9778 >&#13;                                          <CODE
9779 CLASS="parameter"
9780 >enabled</CODE
9781 >
9782 : boolean, Configuration file is active                                 </P
9783 ></LI
9784 ><LI
9785 ><P
9786 >&#13;                                          <CODE
9787 CLASS="parameter"
9788 >conf_file_id</CODE
9789 >
9790 : int, Configuration file identifier                                    </P
9791 ></LI
9792 ><LI
9793 ><P
9794 >&#13;                                          <CODE
9795 CLASS="parameter"
9796 >file_permissions</CODE
9797 >
9798 : string, chmod(1) permissions                                  </P
9799 ></LI
9800 ><LI
9801 ><P
9802 >&#13;                                          <CODE
9803 CLASS="parameter"
9804 >source</CODE
9805 >
9806 : string, Relative path on the boot server where file can be downloaded                                 </P
9807 ></LI
9808 ><LI
9809 ><P
9810 >&#13;                                          <CODE
9811 CLASS="parameter"
9812 >nodegroup_ids</CODE
9813 >
9814 : int, List of node groups linked to this file                                  </P
9815 ></LI
9816 ><LI
9817 ><P
9818 >&#13;                                          <CODE
9819 CLASS="parameter"
9820 >always_update</CODE
9821 >
9822 : boolean, Always attempt to install file even if unchanged                                     </P
9823 ></LI
9824 ><LI
9825 ><P
9826 >&#13;                                          <CODE
9827 CLASS="parameter"
9828 >file_group</CODE
9829 >
9830 : string, chgrp(1) owner                                        </P
9831 ></LI
9832 ></UL
9833 ></LI
9834 ></UL
9835 ></DIV
9836 ><DIV
9837 CLASS="section"
9838 ><HR><H2
9839 CLASS="section"
9840 ><A
9841 NAME="GetEvents"
9842 >2.71. GetEvents</A
9843 ></H2
9844 ><P
9845 >Prototype:<A
9846 NAME="AEN3112"
9847 ></A
9848 ><BLOCKQUOTE
9849 CLASS="BLOCKQUOTE"
9850 ><P
9851 >GetEvents (auth, event_filter, return_fields)</P
9852 ></BLOCKQUOTE
9853 ></P
9854 ><P
9855 >Description:<A
9856 NAME="AEN3115"
9857 ></A
9858 ><BLOCKQUOTE
9859 CLASS="BLOCKQUOTE"
9860 ><P
9861 >Returns an array of structs containing details about events and
9862 faults. If event_filter is specified and is an array of event
9863 identifiers, or a struct of event attributes, only events matching
9864 the filter will be returned. If return_fields is specified, only the
9865 specified details will be returned.</P
9866 ></BLOCKQUOTE
9867 ></P
9868 ><P
9869 >Allowed Roles:<A
9870 NAME="AEN3118"
9871 ></A
9872 ><BLOCKQUOTE
9873 CLASS="BLOCKQUOTE"
9874 ><P
9875 >admin</P
9876 ></BLOCKQUOTE
9877 ></P
9878 ><P
9879 >Parameters:</P
9880 ><P
9881 ></P
9882 ><UL
9883 ><LI
9884 ><P
9885 >&#13;                          <CODE
9886 CLASS="parameter"
9887 >auth</CODE
9888 >
9889 : struct, API authentication structure                  </P
9890 ><P
9891 ></P
9892 ><UL
9893 ><LI
9894 ><P
9895 >&#13;                                          <CODE
9896 CLASS="parameter"
9897 >AuthMethod</CODE
9898 >
9899 : string, Authentication method to use                                  </P
9900 ></LI
9901 ></UL
9902 ></LI
9903 ><LI
9904 ><P
9905 >&#13;                          <CODE
9906 CLASS="parameter"
9907 >event_filter</CODE
9908 >
9909 : array of int or struct                        </P
9910 ><P
9911 ></P
9912 ><UL
9913 ><LI
9914 ><P
9915 >&#13;array of int, Event identifier                                    </P
9916 ></LI
9917 ><LI
9918 ><P
9919 >&#13;struct, Attribute filter                                  </P
9920 ><P
9921 ></P
9922 ><UL
9923 ><LI
9924 ><P
9925 >&#13;                                                          <CODE
9926 CLASS="parameter"
9927 >fault_code</CODE
9928 >
9929 : int or array of int                                                   </P
9930 ><P
9931 ></P
9932 ><UL
9933 ><LI
9934 ><P
9935 >&#13;int, Event fault code                                                                     </P
9936 ></LI
9937 ><LI
9938 ><P
9939 >&#13;array of int, Event fault code                                                                    </P
9940 ></LI
9941 ></UL
9942 ></LI
9943 ><LI
9944 ><P
9945 >&#13;                                                          <CODE
9946 CLASS="parameter"
9947 >event_id</CODE
9948 >
9949 : int or array of int                                                   </P
9950 ><P
9951 ></P
9952 ><UL
9953 ><LI
9954 ><P
9955 >&#13;int, Event identifier                                                                     </P
9956 ></LI
9957 ><LI
9958 ><P
9959 >&#13;array of int, Event identifier                                                                    </P
9960 ></LI
9961 ></UL
9962 ></LI
9963 ><LI
9964 ><P
9965 >&#13;                                                          <CODE
9966 CLASS="parameter"
9967 >object_type</CODE
9968 >
9969 : string or array of string                                                     </P
9970 ><P
9971 ></P
9972 ><UL
9973 ><LI
9974 ><P
9975 >&#13;string, What type of object is this event affecting                                                                       </P
9976 ></LI
9977 ><LI
9978 ><P
9979 >&#13;array of string, What type of object is this event affecting                                                                      </P
9980 ></LI
9981 ></UL
9982 ></LI
9983 ><LI
9984 ><P
9985 >&#13;                                                          <CODE
9986 CLASS="parameter"
9987 >node_id</CODE
9988 >
9989 : int or array of int                                                   </P
9990 ><P
9991 ></P
9992 ><UL
9993 ><LI
9994 ><P
9995 >&#13;int, Identifier of node responsible for event, if any                                                                     </P
9996 ></LI
9997 ><LI
9998 ><P
9999 >&#13;array of int, Identifier of node responsible for event, if any                                                                    </P
10000 ></LI
10001 ></UL
10002 ></LI
10003 ><LI
10004 ><P
10005 >&#13;                                                          <CODE
10006 CLASS="parameter"
10007 >call</CODE
10008 >
10009 : string or array of string                                                     </P
10010 ><P
10011 ></P
10012 ><UL
10013 ><LI
10014 ><P
10015 >&#13;string, Call responsible for this event, including paramters                                                                      </P
10016 ></LI
10017 ><LI
10018 ><P
10019 >&#13;array of string, Call responsible for this event, including paramters                                                                     </P
10020 ></LI
10021 ></UL
10022 ></LI
10023 ><LI
10024 ><P
10025 >&#13;                                                          <CODE
10026 CLASS="parameter"
10027 >time</CODE
10028 >
10029 : int or array of int                                                   </P
10030 ><P
10031 ></P
10032 ><UL
10033 ><LI
10034 ><P
10035 >&#13;int, Date and time that the event took place, in seconds since UNIX epoch                                                                 </P
10036 ></LI
10037 ><LI
10038 ><P
10039 >&#13;array of int, Date and time that the event took place, in seconds since UNIX epoch                                                                        </P
10040 ></LI
10041 ></UL
10042 ></LI
10043 ><LI
10044 ><P
10045 >&#13;                                                          <CODE
10046 CLASS="parameter"
10047 >person_id</CODE
10048 >
10049 : int or array of int                                                   </P
10050 ><P
10051 ></P
10052 ><UL
10053 ><LI
10054 ><P
10055 >&#13;int, Identifier of person responsible for event, if any                                                                   </P
10056 ></LI
10057 ><LI
10058 ><P
10059 >&#13;array of int, Identifier of person responsible for event, if any                                                                  </P
10060 ></LI
10061 ></UL
10062 ></LI
10063 ><LI
10064 ><P
10065 >&#13;                                                          <CODE
10066 CLASS="parameter"
10067 >message</CODE
10068 >
10069 : string or array of string                                                     </P
10070 ><P
10071 ></P
10072 ><UL
10073 ><LI
10074 ><P
10075 >&#13;string, High level description of this event                                                                      </P
10076 ></LI
10077 ><LI
10078 ><P
10079 >&#13;array of string, High level description of this event                                                                     </P
10080 ></LI
10081 ></UL
10082 ></LI
10083 ><LI
10084 ><P
10085 >&#13;                                                          <CODE
10086 CLASS="parameter"
10087 >runtime</CODE
10088 >
10089 : double or array of double                                                     </P
10090 ><P
10091 ></P
10092 ><UL
10093 ><LI
10094 ><P
10095 >&#13;double, Runtime of event                                                                  </P
10096 ></LI
10097 ><LI
10098 ><P
10099 >&#13;array of double, Runtime of event                                                                 </P
10100 ></LI
10101 ></UL
10102 ></LI
10103 ><LI
10104 ><P
10105 >&#13;                                                          <CODE
10106 CLASS="parameter"
10107 >call_name</CODE
10108 >
10109 : string or array of string                                                     </P
10110 ><P
10111 ></P
10112 ><UL
10113 ><LI
10114 ><P
10115 >&#13;string, Call responsible for this event                                                                   </P
10116 ></LI
10117 ><LI
10118 ><P
10119 >&#13;array of string, Call responsible for this event                                                                  </P
10120 ></LI
10121 ></UL
10122 ></LI
10123 ></UL
10124 ></LI
10125 ></UL
10126 ></LI
10127 ><LI
10128 ><P
10129 >&#13;                          <CODE
10130 CLASS="parameter"
10131 >return_fields</CODE
10132 >
10133 : array, List of fields to return                       </P
10134 ><P
10135 ></P
10136 ><UL
10137 ><LI
10138 ><P
10139 >&#13;string                                    </P
10140 ></LI
10141 ></UL
10142 ></LI
10143 ></UL
10144 ><P
10145 >Returns:</P
10146 ><P
10147 ></P
10148 ><UL
10149 ><LI
10150 ><P
10151 >&#13;array of struct                   </P
10152 ><P
10153 ></P
10154 ><UL
10155 ><LI
10156 ><P
10157 >&#13;                                          <CODE
10158 CLASS="parameter"
10159 >fault_code</CODE
10160 >
10161 : int, Event fault code                                 </P
10162 ></LI
10163 ><LI
10164 ><P
10165 >&#13;                                          <CODE
10166 CLASS="parameter"
10167 >event_id</CODE
10168 >
10169 : int, Event identifier                                 </P
10170 ></LI
10171 ><LI
10172 ><P
10173 >&#13;                                          <CODE
10174 CLASS="parameter"
10175 >object_type</CODE
10176 >
10177 : string, What type of object is this event affecting                                   </P
10178 ></LI
10179 ><LI
10180 ><P
10181 >&#13;                                          <CODE
10182 CLASS="parameter"
10183 >object_ids</CODE
10184 >
10185 : array, IDs of objects affected by this event                                  </P
10186 ><P
10187 ></P
10188 ><UL
10189 ><LI
10190 ><P
10191 >&#13;int                                                       </P
10192 ></LI
10193 ></UL
10194 ></LI
10195 ><LI
10196 ><P
10197 >&#13;                                          <CODE
10198 CLASS="parameter"
10199 >node_id</CODE
10200 >
10201 : int, Identifier of node responsible for event, if any                                 </P
10202 ></LI
10203 ><LI
10204 ><P
10205 >&#13;                                          <CODE
10206 CLASS="parameter"
10207 >call</CODE
10208 >
10209 : string, Call responsible for this event, including paramters                                  </P
10210 ></LI
10211 ><LI
10212 ><P
10213 >&#13;                                          <CODE
10214 CLASS="parameter"
10215 >time</CODE
10216 >
10217 : int, Date and time that the event took place, in seconds since UNIX epoch                                     </P
10218 ></LI
10219 ><LI
10220 ><P
10221 >&#13;                                          <CODE
10222 CLASS="parameter"
10223 >person_id</CODE
10224 >
10225 : int, Identifier of person responsible for event, if any                                       </P
10226 ></LI
10227 ><LI
10228 ><P
10229 >&#13;                                          <CODE
10230 CLASS="parameter"
10231 >message</CODE
10232 >
10233 : string, High level description of this event                                  </P
10234 ></LI
10235 ><LI
10236 ><P
10237 >&#13;                                          <CODE
10238 CLASS="parameter"
10239 >runtime</CODE
10240 >
10241 : double, Runtime of event                                      </P
10242 ></LI
10243 ><LI
10244 ><P
10245 >&#13;                                          <CODE
10246 CLASS="parameter"
10247 >call_name</CODE
10248 >
10249 : string, Call responsible for this event                                       </P
10250 ></LI
10251 ></UL
10252 ></LI
10253 ></UL
10254 ></DIV
10255 ><DIV
10256 CLASS="section"
10257 ><HR><H2
10258 CLASS="section"
10259 ><A
10260 NAME="GetKeys"
10261 >2.72. GetKeys</A
10262 ></H2
10263 ><P
10264 >Prototype:<A
10265 NAME="AEN3268"
10266 ></A
10267 ><BLOCKQUOTE
10268 CLASS="BLOCKQUOTE"
10269 ><P
10270 >GetKeys (auth, key_filter, return_fields)</P
10271 ></BLOCKQUOTE
10272 ></P
10273 ><P
10274 >Description:<A
10275 NAME="AEN3271"
10276 ></A
10277 ><BLOCKQUOTE
10278 CLASS="BLOCKQUOTE"
10279 ><P
10280 >Returns an array of structs containing details about keys. If
10281 key_filter is specified and is an array of key identifiers, or a
10282 struct of key attributes, only keys matching the filter will be
10283 returned. If return_fields is specified, only the specified
10284 details will be returned.</P
10285 ><P
10286 >Admin may query all keys. Non-admins may only query their own
10287 keys.</P
10288 ></BLOCKQUOTE
10289 ></P
10290 ><P
10291 >Allowed Roles:<A
10292 NAME="AEN3275"
10293 ></A
10294 ><BLOCKQUOTE
10295 CLASS="BLOCKQUOTE"
10296 ><P
10297 >admin, pi, user, tech, node</P
10298 ></BLOCKQUOTE
10299 ></P
10300 ><P
10301 >Parameters:</P
10302 ><P
10303 ></P
10304 ><UL
10305 ><LI
10306 ><P
10307 >&#13;                          <CODE
10308 CLASS="parameter"
10309 >auth</CODE
10310 >
10311 : struct, API authentication structure                  </P
10312 ><P
10313 ></P
10314 ><UL
10315 ><LI
10316 ><P
10317 >&#13;                                          <CODE
10318 CLASS="parameter"
10319 >AuthMethod</CODE
10320 >
10321 : string, Authentication method to use                                  </P
10322 ></LI
10323 ></UL
10324 ></LI
10325 ><LI
10326 ><P
10327 >&#13;                          <CODE
10328 CLASS="parameter"
10329 >key_filter</CODE
10330 >
10331 : array of int or struct                        </P
10332 ><P
10333 ></P
10334 ><UL
10335 ><LI
10336 ><P
10337 >&#13;array of int                                      </P
10338 ><P
10339 ></P
10340 ><UL
10341 ><LI
10342 ><P
10343 >&#13;int, Key identifier                                                       </P
10344 ></LI
10345 ></UL
10346 ></LI
10347 ><LI
10348 ><P
10349 >&#13;struct, Attribute filter                                  </P
10350 ><P
10351 ></P
10352 ><UL
10353 ><LI
10354 ><P
10355 >&#13;                                                          <CODE
10356 CLASS="parameter"
10357 >peer_key_id</CODE
10358 >
10359 : int or array of int                                                   </P
10360 ><P
10361 ></P
10362 ><UL
10363 ><LI
10364 ><P
10365 >&#13;int, Foreign key identifier at peer                                                                       </P
10366 ></LI
10367 ><LI
10368 ><P
10369 >&#13;array of int, Foreign key identifier at peer                                                                      </P
10370 ></LI
10371 ></UL
10372 ></LI
10373 ><LI
10374 ><P
10375 >&#13;                                                          <CODE
10376 CLASS="parameter"
10377 >key_type</CODE
10378 >
10379 : string or array of string                                                     </P
10380 ><P
10381 ></P
10382 ><UL
10383 ><LI
10384 ><P
10385 >&#13;string, Key type                                                                  </P
10386 ></LI
10387 ><LI
10388 ><P
10389 >&#13;array of string, Key type                                                                 </P
10390 ></LI
10391 ></UL
10392 ></LI
10393 ><LI
10394 ><P
10395 >&#13;                                                          <CODE
10396 CLASS="parameter"
10397 >key</CODE
10398 >
10399 : string or array of string                                                     </P
10400 ><P
10401 ></P
10402 ><UL
10403 ><LI
10404 ><P
10405 >&#13;string, Key value                                                                 </P
10406 ></LI
10407 ><LI
10408 ><P
10409 >&#13;array of string, Key value                                                                        </P
10410 ></LI
10411 ></UL
10412 ></LI
10413 ><LI
10414 ><P
10415 >&#13;                                                          <CODE
10416 CLASS="parameter"
10417 >person_id</CODE
10418 >
10419 : int or array of int                                                   </P
10420 ><P
10421 ></P
10422 ><UL
10423 ><LI
10424 ><P
10425 >&#13;int, User to which this key belongs                                                                       </P
10426 ></LI
10427 ><LI
10428 ><P
10429 >&#13;array of int, User to which this key belongs                                                                      </P
10430 ></LI
10431 ></UL
10432 ></LI
10433 ><LI
10434 ><P
10435 >&#13;                                                          <CODE
10436 CLASS="parameter"
10437 >key_id</CODE
10438 >
10439 : int or array of int                                                   </P
10440 ><P
10441 ></P
10442 ><UL
10443 ><LI
10444 ><P
10445 >&#13;int, Key identifier                                                                       </P
10446 ></LI
10447 ><LI
10448 ><P
10449 >&#13;array of int, Key identifier                                                                      </P
10450 ></LI
10451 ></UL
10452 ></LI
10453 ><LI
10454 ><P
10455 >&#13;                                                          <CODE
10456 CLASS="parameter"
10457 >peer_id</CODE
10458 >
10459 : int or array of int                                                   </P
10460 ><P
10461 ></P
10462 ><UL
10463 ><LI
10464 ><P
10465 >&#13;int, Peer to which this key belongs                                                                       </P
10466 ></LI
10467 ><LI
10468 ><P
10469 >&#13;array of int, Peer to which this key belongs                                                                      </P
10470 ></LI
10471 ></UL
10472 ></LI
10473 ></UL
10474 ></LI
10475 ></UL
10476 ></LI
10477 ><LI
10478 ><P
10479 >&#13;                          <CODE
10480 CLASS="parameter"
10481 >return_fields</CODE
10482 >
10483 : array, List of fields to return                       </P
10484 ><P
10485 ></P
10486 ><UL
10487 ><LI
10488 ><P
10489 >&#13;string                                    </P
10490 ></LI
10491 ></UL
10492 ></LI
10493 ></UL
10494 ><P
10495 >Returns:</P
10496 ><P
10497 ></P
10498 ><UL
10499 ><LI
10500 ><P
10501 >&#13;array of struct                   </P
10502 ><P
10503 ></P
10504 ><UL
10505 ><LI
10506 ><P
10507 >&#13;                                          <CODE
10508 CLASS="parameter"
10509 >peer_id</CODE
10510 >
10511 : int, Peer to which this key belongs                                   </P
10512 ></LI
10513 ><LI
10514 ><P
10515 >&#13;                                          <CODE
10516 CLASS="parameter"
10517 >key_type</CODE
10518 >
10519 : string, Key type                                      </P
10520 ></LI
10521 ><LI
10522 ><P
10523 >&#13;                                          <CODE
10524 CLASS="parameter"
10525 >key</CODE
10526 >
10527 : string, Key value                                     </P
10528 ></LI
10529 ><LI
10530 ><P
10531 >&#13;                                          <CODE
10532 CLASS="parameter"
10533 >person_id</CODE
10534 >
10535 : int, User to which this key belongs                                   </P
10536 ></LI
10537 ><LI
10538 ><P
10539 >&#13;                                          <CODE
10540 CLASS="parameter"
10541 >key_id</CODE
10542 >
10543 : int, Key identifier                                   </P
10544 ></LI
10545 ><LI
10546 ><P
10547 >&#13;                                          <CODE
10548 CLASS="parameter"
10549 >peer_key_id</CODE
10550 >
10551 : int, Foreign key identifier at peer                                   </P
10552 ></LI
10553 ></UL
10554 ></LI
10555 ></UL
10556 ></DIV
10557 ><DIV
10558 CLASS="section"
10559 ><HR><H2
10560 CLASS="section"
10561 ><A
10562 NAME="GetKeyTypes"
10563 >2.73. GetKeyTypes</A
10564 ></H2
10565 ><P
10566 >Prototype:<A
10567 NAME="AEN3378"
10568 ></A
10569 ><BLOCKQUOTE
10570 CLASS="BLOCKQUOTE"
10571 ><P
10572 >GetKeyTypes (auth)</P
10573 ></BLOCKQUOTE
10574 ></P
10575 ><P
10576 >Description:<A
10577 NAME="AEN3381"
10578 ></A
10579 ><BLOCKQUOTE
10580 CLASS="BLOCKQUOTE"
10581 ><P
10582 >Returns an array of all valid key types.</P
10583 ></BLOCKQUOTE
10584 ></P
10585 ><P
10586 >Allowed Roles:<A
10587 NAME="AEN3384"
10588 ></A
10589 ><BLOCKQUOTE
10590 CLASS="BLOCKQUOTE"
10591 ><P
10592 >admin, pi, user, tech, node</P
10593 ></BLOCKQUOTE
10594 ></P
10595 ><P
10596 >Parameters:</P
10597 ><P
10598 ></P
10599 ><UL
10600 ><LI
10601 ><P
10602 >&#13;                          <CODE
10603 CLASS="parameter"
10604 >auth</CODE
10605 >
10606 : struct, API authentication structure                  </P
10607 ><P
10608 ></P
10609 ><UL
10610 ><LI
10611 ><P
10612 >&#13;                                          <CODE
10613 CLASS="parameter"
10614 >AuthMethod</CODE
10615 >
10616 : string, Authentication method to use                                  </P
10617 ></LI
10618 ></UL
10619 ></LI
10620 ></UL
10621 ><P
10622 >Returns:</P
10623 ><P
10624 ></P
10625 ><UL
10626 ><LI
10627 ><P
10628 >&#13;array of string, Key type                 </P
10629 ></LI
10630 ></UL
10631 ></DIV
10632 ><DIV
10633 CLASS="section"
10634 ><HR><H2
10635 CLASS="section"
10636 ><A
10637 NAME="GetMessages"
10638 >2.74. GetMessages</A
10639 ></H2
10640 ><P
10641 >Prototype:<A
10642 NAME="AEN3402"
10643 ></A
10644 ><BLOCKQUOTE
10645 CLASS="BLOCKQUOTE"
10646 ><P
10647 >GetMessages (auth, message_filter, return_fields)</P
10648 ></BLOCKQUOTE
10649 ></P
10650 ><P
10651 >Description:<A
10652 NAME="AEN3405"
10653 ></A
10654 ><BLOCKQUOTE
10655 CLASS="BLOCKQUOTE"
10656 ><P
10657 >Returns an array of structs containing details about message
10658 templates. If message template_filter is specified and is an array
10659 of message template identifiers, or a struct of message template
10660 attributes, only message templates matching the filter will be
10661 returned. If return_fields is specified, only the specified
10662 details will be returned.</P
10663 ></BLOCKQUOTE
10664 ></P
10665 ><P
10666 >Allowed Roles:<A
10667 NAME="AEN3408"
10668 ></A
10669 ><BLOCKQUOTE
10670 CLASS="BLOCKQUOTE"
10671 ><P
10672 >admin, node</P
10673 ></BLOCKQUOTE
10674 ></P
10675 ><P
10676 >Parameters:</P
10677 ><P
10678 ></P
10679 ><UL
10680 ><LI
10681 ><P
10682 >&#13;                          <CODE
10683 CLASS="parameter"
10684 >auth</CODE
10685 >
10686 : struct, API authentication structure                  </P
10687 ><P
10688 ></P
10689 ><UL
10690 ><LI
10691 ><P
10692 >&#13;                                          <CODE
10693 CLASS="parameter"
10694 >AuthMethod</CODE
10695 >
10696 : string, Authentication method to use                                  </P
10697 ></LI
10698 ></UL
10699 ></LI
10700 ><LI
10701 ><P
10702 >&#13;                          <CODE
10703 CLASS="parameter"
10704 >message_filter</CODE
10705 >
10706 : array of string or struct                     </P
10707 ><P
10708 ></P
10709 ><UL
10710 ><LI
10711 ><P
10712 >&#13;array of string, Message identifier                                       </P
10713 ></LI
10714 ><LI
10715 ><P
10716 >&#13;struct, Attribute filter                                  </P
10717 ><P
10718 ></P
10719 ><UL
10720 ><LI
10721 ><P
10722 >&#13;                                                          <CODE
10723 CLASS="parameter"
10724 >enabled</CODE
10725 >
10726 : boolean or array of boolean                                                   </P
10727 ><P
10728 ></P
10729 ><UL
10730 ><LI
10731 ><P
10732 >&#13;boolean, Message is enabled                                                                       </P
10733 ></LI
10734 ><LI
10735 ><P
10736 >&#13;array of boolean, Message is enabled                                                                      </P
10737 ></LI
10738 ></UL
10739 ></LI
10740 ><LI
10741 ><P
10742 >&#13;                                                          <CODE
10743 CLASS="parameter"
10744 >message_id</CODE
10745 >
10746 : string or array of string                                                     </P
10747 ><P
10748 ></P
10749 ><UL
10750 ><LI
10751 ><P
10752 >&#13;string, Message identifier                                                                        </P
10753 ></LI
10754 ><LI
10755 ><P
10756 >&#13;array of string, Message identifier                                                                       </P
10757 ></LI
10758 ></UL
10759 ></LI
10760 ><LI
10761 ><P
10762 >&#13;                                                          <CODE
10763 CLASS="parameter"
10764 >template</CODE
10765 >
10766 : string or array of string                                                     </P
10767 ><P
10768 ></P
10769 ><UL
10770 ><LI
10771 ><P
10772 >&#13;string, Message template                                                                  </P
10773 ></LI
10774 ><LI
10775 ><P
10776 >&#13;array of string, Message template                                                                 </P
10777 ></LI
10778 ></UL
10779 ></LI
10780 ><LI
10781 ><P
10782 >&#13;                                                          <CODE
10783 CLASS="parameter"
10784 >subject</CODE
10785 >
10786 : string or array of string                                                     </P
10787 ><P
10788 ></P
10789 ><UL
10790 ><LI
10791 ><P
10792 >&#13;string, Message summary                                                                   </P
10793 ></LI
10794 ><LI
10795 ><P
10796 >&#13;array of string, Message summary                                                                  </P
10797 ></LI
10798 ></UL
10799 ></LI
10800 ></UL
10801 ></LI
10802 ></UL
10803 ></LI
10804 ><LI
10805 ><P
10806 >&#13;                          <CODE
10807 CLASS="parameter"
10808 >return_fields</CODE
10809 >
10810 : array, List of fields to return                       </P
10811 ><P
10812 ></P
10813 ><UL
10814 ><LI
10815 ><P
10816 >&#13;string                                    </P
10817 ></LI
10818 ></UL
10819 ></LI
10820 ></UL
10821 ><P
10822 >Returns:</P
10823 ><P
10824 ></P
10825 ><UL
10826 ><LI
10827 ><P
10828 >&#13;array of struct                   </P
10829 ><P
10830 ></P
10831 ><UL
10832 ><LI
10833 ><P
10834 >&#13;                                          <CODE
10835 CLASS="parameter"
10836 >enabled</CODE
10837 >
10838 : boolean, Message is enabled                                   </P
10839 ></LI
10840 ><LI
10841 ><P
10842 >&#13;                                          <CODE
10843 CLASS="parameter"
10844 >message_id</CODE
10845 >
10846 : string, Message identifier                                    </P
10847 ></LI
10848 ><LI
10849 ><P
10850 >&#13;                                          <CODE
10851 CLASS="parameter"
10852 >template</CODE
10853 >
10854 : string, Message template                                      </P
10855 ></LI
10856 ><LI
10857 ><P
10858 >&#13;                                          <CODE
10859 CLASS="parameter"
10860 >subject</CODE
10861 >
10862 : string, Message summary                                       </P
10863 ></LI
10864 ></UL
10865 ></LI
10866 ></UL
10867 ></DIV
10868 ><DIV
10869 CLASS="section"
10870 ><HR><H2
10871 CLASS="section"
10872 ><A
10873 NAME="GetNetworkMethods"
10874 >2.75. GetNetworkMethods</A
10875 ></H2
10876 ><P
10877 >Prototype:<A
10878 NAME="AEN3486"
10879 ></A
10880 ><BLOCKQUOTE
10881 CLASS="BLOCKQUOTE"
10882 ><P
10883 >GetNetworkMethods (auth)</P
10884 ></BLOCKQUOTE
10885 ></P
10886 ><P
10887 >Description:<A
10888 NAME="AEN3489"
10889 ></A
10890 ><BLOCKQUOTE
10891 CLASS="BLOCKQUOTE"
10892 ><P
10893 >Returns a list of all valid network methods.</P
10894 ></BLOCKQUOTE
10895 ></P
10896 ><P
10897 >Allowed Roles:<A
10898 NAME="AEN3492"
10899 ></A
10900 ><BLOCKQUOTE
10901 CLASS="BLOCKQUOTE"
10902 ><P
10903 >admin, pi, user, tech, node</P
10904 ></BLOCKQUOTE
10905 ></P
10906 ><P
10907 >Parameters:</P
10908 ><P
10909 ></P
10910 ><UL
10911 ><LI
10912 ><P
10913 >&#13;                          <CODE
10914 CLASS="parameter"
10915 >auth</CODE
10916 >
10917 : struct, API authentication structure                  </P
10918 ><P
10919 ></P
10920 ><UL
10921 ><LI
10922 ><P
10923 >&#13;                                          <CODE
10924 CLASS="parameter"
10925 >AuthMethod</CODE
10926 >
10927 : string, Authentication method to use                                  </P
10928 ></LI
10929 ></UL
10930 ></LI
10931 ></UL
10932 ><P
10933 >Returns:</P
10934 ><P
10935 ></P
10936 ><UL
10937 ><LI
10938 ><P
10939 >&#13;array of string, Network method                   </P
10940 ></LI
10941 ></UL
10942 ></DIV
10943 ><DIV
10944 CLASS="section"
10945 ><HR><H2
10946 CLASS="section"
10947 ><A
10948 NAME="GetNetworkTypes"
10949 >2.76. GetNetworkTypes</A
10950 ></H2
10951 ><P
10952 >Prototype:<A
10953 NAME="AEN3510"
10954 ></A
10955 ><BLOCKQUOTE
10956 CLASS="BLOCKQUOTE"
10957 ><P
10958 >GetNetworkTypes (auth)</P
10959 ></BLOCKQUOTE
10960 ></P
10961 ><P
10962 >Description:<A
10963 NAME="AEN3513"
10964 ></A
10965 ><BLOCKQUOTE
10966 CLASS="BLOCKQUOTE"
10967 ><P
10968 >Returns a list of all valid network types.</P
10969 ></BLOCKQUOTE
10970 ></P
10971 ><P
10972 >Allowed Roles:<A
10973 NAME="AEN3516"
10974 ></A
10975 ><BLOCKQUOTE
10976 CLASS="BLOCKQUOTE"
10977 ><P
10978 >admin, pi, user, tech, node</P
10979 ></BLOCKQUOTE
10980 ></P
10981 ><P
10982 >Parameters:</P
10983 ><P
10984 ></P
10985 ><UL
10986 ><LI
10987 ><P
10988 >&#13;                          <CODE
10989 CLASS="parameter"
10990 >auth</CODE
10991 >
10992 : struct, API authentication structure                  </P
10993 ><P
10994 ></P
10995 ><UL
10996 ><LI
10997 ><P
10998 >&#13;                                          <CODE
10999 CLASS="parameter"
11000 >AuthMethod</CODE
11001 >
11002 : string, Authentication method to use                                  </P
11003 ></LI
11004 ></UL
11005 ></LI
11006 ></UL
11007 ><P
11008 >Returns:</P
11009 ><P
11010 ></P
11011 ><UL
11012 ><LI
11013 ><P
11014 >&#13;array of string, Network type                     </P
11015 ></LI
11016 ></UL
11017 ></DIV
11018 ><DIV
11019 CLASS="section"
11020 ><HR><H2
11021 CLASS="section"
11022 ><A
11023 NAME="GetNodeGroups"
11024 >2.77. GetNodeGroups</A
11025 ></H2
11026 ><P
11027 >Prototype:<A
11028 NAME="AEN3534"
11029 ></A
11030 ><BLOCKQUOTE
11031 CLASS="BLOCKQUOTE"
11032 ><P
11033 >GetNodeGroups (auth, nodegroup_filter, return_fields)</P
11034 ></BLOCKQUOTE
11035 ></P
11036 ><P
11037 >Description:<A
11038 NAME="AEN3537"
11039 ></A
11040 ><BLOCKQUOTE
11041 CLASS="BLOCKQUOTE"
11042 ><P
11043 >Returns an array of structs containing details about node groups.
11044 If nodegroup_filter is specified and is an array of node group
11045 identifiers or names, or a struct of node group attributes, only
11046 node groups matching the filter will be returned. If return_fields
11047 is specified, only the specified details will be returned.</P
11048 ></BLOCKQUOTE
11049 ></P
11050 ><P
11051 >Allowed Roles:<A
11052 NAME="AEN3540"
11053 ></A
11054 ><BLOCKQUOTE
11055 CLASS="BLOCKQUOTE"
11056 ><P
11057 >admin, pi, user, tech, node, anonymous</P
11058 ></BLOCKQUOTE
11059 ></P
11060 ><P
11061 >Parameters:</P
11062 ><P
11063 ></P
11064 ><UL
11065 ><LI
11066 ><P
11067 >&#13;                          <CODE
11068 CLASS="parameter"
11069 >auth</CODE
11070 >
11071 : struct, API authentication structure                  </P
11072 ><P
11073 ></P
11074 ><UL
11075 ><LI
11076 ><P
11077 >&#13;                                          <CODE
11078 CLASS="parameter"
11079 >AuthMethod</CODE
11080 >
11081 : string, Authentication method to use                                  </P
11082 ></LI
11083 ></UL
11084 ></LI
11085 ><LI
11086 ><P
11087 >&#13;                          <CODE
11088 CLASS="parameter"
11089 >nodegroup_filter</CODE
11090 >
11091 : array of int or string or struct                      </P
11092 ><P
11093 ></P
11094 ><UL
11095 ><LI
11096 ><P
11097 >&#13;array of int or string                                    </P
11098 ><P
11099 ></P
11100 ><UL
11101 ><LI
11102 ><P
11103 >&#13;int, Node group identifier                                                        </P
11104 ></LI
11105 ><LI
11106 ><P
11107 >&#13;string, Node group name                                                   </P
11108 ></LI
11109 ></UL
11110 ></LI
11111 ><LI
11112 ><P
11113 >&#13;struct, Attribute filter                                  </P
11114 ><P
11115 ></P
11116 ><UL
11117 ><LI
11118 ><P
11119 >&#13;                                                          <CODE
11120 CLASS="parameter"
11121 >nodegroup_id</CODE
11122 >
11123 : int or array of int                                                   </P
11124 ><P
11125 ></P
11126 ><UL
11127 ><LI
11128 ><P
11129 >&#13;int, Node group identifier                                                                        </P
11130 ></LI
11131 ><LI
11132 ><P
11133 >&#13;array of int, Node group identifier                                                                       </P
11134 ></LI
11135 ></UL
11136 ></LI
11137 ><LI
11138 ><P
11139 >&#13;                                                          <CODE
11140 CLASS="parameter"
11141 >name</CODE
11142 >
11143 : string or array of string                                                     </P
11144 ><P
11145 ></P
11146 ><UL
11147 ><LI
11148 ><P
11149 >&#13;string, Node group name                                                                   </P
11150 ></LI
11151 ><LI
11152 ><P
11153 >&#13;array of string, Node group name                                                                  </P
11154 ></LI
11155 ></UL
11156 ></LI
11157 ><LI
11158 ><P
11159 >&#13;                                                          <CODE
11160 CLASS="parameter"
11161 >description</CODE
11162 >
11163 : string or array of string                                                     </P
11164 ><P
11165 ></P
11166 ><UL
11167 ><LI
11168 ><P
11169 >&#13;string, Node group description                                                                    </P
11170 ></LI
11171 ><LI
11172 ><P
11173 >&#13;array of string, Node group description                                                                   </P
11174 ></LI
11175 ></UL
11176 ></LI
11177 ></UL
11178 ></LI
11179 ></UL
11180 ></LI
11181 ><LI
11182 ><P
11183 >&#13;                          <CODE
11184 CLASS="parameter"
11185 >return_fields</CODE
11186 >
11187 : array, List of fields to return                       </P
11188 ><P
11189 ></P
11190 ><UL
11191 ><LI
11192 ><P
11193 >&#13;string                                    </P
11194 ></LI
11195 ></UL
11196 ></LI
11197 ></UL
11198 ><P
11199 >Returns:</P
11200 ><P
11201 ></P
11202 ><UL
11203 ><LI
11204 ><P
11205 >&#13;array of struct                   </P
11206 ><P
11207 ></P
11208 ><UL
11209 ><LI
11210 ><P
11211 >&#13;                                          <CODE
11212 CLASS="parameter"
11213 >node_ids</CODE
11214 >
11215 : array, List of nodes in this node group                                       </P
11216 ><P
11217 ></P
11218 ><UL
11219 ><LI
11220 ><P
11221 >&#13;int                                                       </P
11222 ></LI
11223 ></UL
11224 ></LI
11225 ><LI
11226 ><P
11227 >&#13;                                          <CODE
11228 CLASS="parameter"
11229 >nodegroup_id</CODE
11230 >
11231 : int, Node group identifier                                    </P
11232 ></LI
11233 ><LI
11234 ><P
11235 >&#13;                                          <CODE
11236 CLASS="parameter"
11237 >name</CODE
11238 >
11239 : string, Node group name                                       </P
11240 ></LI
11241 ><LI
11242 ><P
11243 >&#13;                                          <CODE
11244 CLASS="parameter"
11245 >conf_file_ids</CODE
11246 >
11247 : array, List of configuration files specific to this node group                                        </P
11248 ><P
11249 ></P
11250 ><UL
11251 ><LI
11252 ><P
11253 >&#13;int                                                       </P
11254 ></LI
11255 ></UL
11256 ></LI
11257 ><LI
11258 ><P
11259 >&#13;                                          <CODE
11260 CLASS="parameter"
11261 >description</CODE
11262 >
11263 : string, Node group description                                        </P
11264 ></LI
11265 ></UL
11266 ></LI
11267 ></UL
11268 ></DIV
11269 ><DIV
11270 CLASS="section"
11271 ><HR><H2
11272 CLASS="section"
11273 ><A
11274 NAME="GetNodeNetworks"
11275 >2.78. GetNodeNetworks</A
11276 ></H2
11277 ><P
11278 >Prototype:<A
11279 NAME="AEN3624"
11280 ></A
11281 ><BLOCKQUOTE
11282 CLASS="BLOCKQUOTE"
11283 ><P
11284 >GetNodeNetworks (auth, nodenetwork_filter, return_fields)</P
11285 ></BLOCKQUOTE
11286 ></P
11287 ><P
11288 >Description:<A
11289 NAME="AEN3627"
11290 ></A
11291 ><BLOCKQUOTE
11292 CLASS="BLOCKQUOTE"
11293 ><P
11294 >Returns an array of structs containing details about node network
11295 interfacess. If nodenetworks_filter is specified and is an array
11296 of node network identifiers, or a struct of node network
11297 attributes, only node network interfaces matching the filter will
11298 be returned. If return_fields is specified, only the
11299 specified details will be returned.</P
11300 ></BLOCKQUOTE
11301 ></P
11302 ><P
11303 >Allowed Roles:<A
11304 NAME="AEN3630"
11305 ></A
11306 ><BLOCKQUOTE
11307 CLASS="BLOCKQUOTE"
11308 ><P
11309 >admin, pi, user, tech, node, anonymous</P
11310 ></BLOCKQUOTE
11311 ></P
11312 ><P
11313 >Parameters:</P
11314 ><P
11315 ></P
11316 ><UL
11317 ><LI
11318 ><P
11319 >&#13;                          <CODE
11320 CLASS="parameter"
11321 >auth</CODE
11322 >
11323 : struct, API authentication structure                  </P
11324 ><P
11325 ></P
11326 ><UL
11327 ><LI
11328 ><P
11329 >&#13;                                          <CODE
11330 CLASS="parameter"
11331 >AuthMethod</CODE
11332 >
11333 : string, Authentication method to use                                  </P
11334 ></LI
11335 ></UL
11336 ></LI
11337 ><LI
11338 ><P
11339 >&#13;                          <CODE
11340 CLASS="parameter"
11341 >nodenetwork_filter</CODE
11342 >
11343 : array of int or struct                        </P
11344 ><P
11345 ></P
11346 ><UL
11347 ><LI
11348 ><P
11349 >&#13;array of int, Node interface identifier                                   </P
11350 ></LI
11351 ><LI
11352 ><P
11353 >&#13;struct, Attribute filter                                  </P
11354 ><P
11355 ></P
11356 ><UL
11357 ><LI
11358 ><P
11359 >&#13;                                                          <CODE
11360 CLASS="parameter"
11361 >nodenetwork_id</CODE
11362 >
11363 : int or array of int                                                   </P
11364 ><P
11365 ></P
11366 ><UL
11367 ><LI
11368 ><P
11369 >&#13;int, Node interface identifier                                                                    </P
11370 ></LI
11371 ><LI
11372 ><P
11373 >&#13;array of int, Node interface identifier                                                                   </P
11374 ></LI
11375 ></UL
11376 ></LI
11377 ><LI
11378 ><P
11379 >&#13;                                                          <CODE
11380 CLASS="parameter"
11381 >network</CODE
11382 >
11383 : string or array of string                                                     </P
11384 ><P
11385 ></P
11386 ><UL
11387 ><LI
11388 ><P
11389 >&#13;string, Subnet address                                                                    </P
11390 ></LI
11391 ><LI
11392 ><P
11393 >&#13;array of string, Subnet address                                                                   </P
11394 ></LI
11395 ></UL
11396 ></LI
11397 ><LI
11398 ><P
11399 >&#13;                                                          <CODE
11400 CLASS="parameter"
11401 >is_primary</CODE
11402 >
11403 : boolean or array of boolean                                                   </P
11404 ><P
11405 ></P
11406 ><UL
11407 ><LI
11408 ><P
11409 >&#13;boolean, Is the primary interface for this node                                                                   </P
11410 ></LI
11411 ><LI
11412 ><P
11413 >&#13;array of boolean, Is the primary interface for this node                                                                  </P
11414 ></LI
11415 ></UL
11416 ></LI
11417 ><LI
11418 ><P
11419 >&#13;                                                          <CODE
11420 CLASS="parameter"
11421 >dns1</CODE
11422 >
11423 : string or array of string                                                     </P
11424 ><P
11425 ></P
11426 ><UL
11427 ><LI
11428 ><P
11429 >&#13;string, IP address of primary DNS server                                                                  </P
11430 ></LI
11431 ><LI
11432 ><P
11433 >&#13;array of string, IP address of primary DNS server                                                                 </P
11434 ></LI
11435 ></UL
11436 ></LI
11437 ><LI
11438 ><P
11439 >&#13;                                                          <CODE
11440 CLASS="parameter"
11441 >hostname</CODE
11442 >
11443 : string or array of string                                                     </P
11444 ><P
11445 ></P
11446 ><UL
11447 ><LI
11448 ><P
11449 >&#13;string, (Optional) Hostname                                                                       </P
11450 ></LI
11451 ><LI
11452 ><P
11453 >&#13;array of string, (Optional) Hostname                                                                      </P
11454 ></LI
11455 ></UL
11456 ></LI
11457 ><LI
11458 ><P
11459 >&#13;                                                          <CODE
11460 CLASS="parameter"
11461 >mac</CODE
11462 >
11463 : string or array of string                                                     </P
11464 ><P
11465 ></P
11466 ><UL
11467 ><LI
11468 ><P
11469 >&#13;string, MAC address                                                                       </P
11470 ></LI
11471 ><LI
11472 ><P
11473 >&#13;array of string, MAC address                                                                      </P
11474 ></LI
11475 ></UL
11476 ></LI
11477 ><LI
11478 ><P
11479 >&#13;                                                          <CODE
11480 CLASS="parameter"
11481 >bwlimit</CODE
11482 >
11483 : int or array of int                                                   </P
11484 ><P
11485 ></P
11486 ><UL
11487 ><LI
11488 ><P
11489 >&#13;int, Bandwidth limit                                                                      </P
11490 ></LI
11491 ><LI
11492 ><P
11493 >&#13;array of int, Bandwidth limit                                                                     </P
11494 ></LI
11495 ></UL
11496 ></LI
11497 ><LI
11498 ><P
11499 >&#13;                                                          <CODE
11500 CLASS="parameter"
11501 >broadcast</CODE
11502 >
11503 : string or array of string                                                     </P
11504 ><P
11505 ></P
11506 ><UL
11507 ><LI
11508 ><P
11509 >&#13;string, Network broadcast address                                                                 </P
11510 ></LI
11511 ><LI
11512 ><P
11513 >&#13;array of string, Network broadcast address                                                                        </P
11514 ></LI
11515 ></UL
11516 ></LI
11517 ><LI
11518 ><P
11519 >&#13;                                                          <CODE
11520 CLASS="parameter"
11521 >method</CODE
11522 >
11523 : string or array of string                                                     </P
11524 ><P
11525 ></P
11526 ><UL
11527 ><LI
11528 ><P
11529 >&#13;string, Addressing method (e.g., 'static' or 'dhcp')                                                                      </P
11530 ></LI
11531 ><LI
11532 ><P
11533 >&#13;array of string, Addressing method (e.g., 'static' or 'dhcp')                                                                     </P
11534 ></LI
11535 ></UL
11536 ></LI
11537 ><LI
11538 ><P
11539 >&#13;                                                          <CODE
11540 CLASS="parameter"
11541 >netmask</CODE
11542 >
11543 : string or array of string                                                     </P
11544 ><P
11545 ></P
11546 ><UL
11547 ><LI
11548 ><P
11549 >&#13;string, Subnet mask                                                                       </P
11550 ></LI
11551 ><LI
11552 ><P
11553 >&#13;array of string, Subnet mask                                                                      </P
11554 ></LI
11555 ></UL
11556 ></LI
11557 ><LI
11558 ><P
11559 >&#13;                                                          <CODE
11560 CLASS="parameter"
11561 >node_id</CODE
11562 >
11563 : int or array of int                                                   </P
11564 ><P
11565 ></P
11566 ><UL
11567 ><LI
11568 ><P
11569 >&#13;int, Node associated with this interface                                                                  </P
11570 ></LI
11571 ><LI
11572 ><P
11573 >&#13;array of int, Node associated with this interface                                                                 </P
11574 ></LI
11575 ></UL
11576 ></LI
11577 ><LI
11578 ><P
11579 >&#13;                                                          <CODE
11580 CLASS="parameter"
11581 >dns2</CODE
11582 >
11583 : string or array of string                                                     </P
11584 ><P
11585 ></P
11586 ><UL
11587 ><LI
11588 ><P
11589 >&#13;string, IP address of secondary DNS server                                                                        </P
11590 ></LI
11591 ><LI
11592 ><P
11593 >&#13;array of string, IP address of secondary DNS server                                                                       </P
11594 ></LI
11595 ></UL
11596 ></LI
11597 ><LI
11598 ><P
11599 >&#13;                                                          <CODE
11600 CLASS="parameter"
11601 >ip</CODE
11602 >
11603 : string or array of string                                                     </P
11604 ><P
11605 ></P
11606 ><UL
11607 ><LI
11608 ><P
11609 >&#13;string, IP address                                                                        </P
11610 ></LI
11611 ><LI
11612 ><P
11613 >&#13;array of string, IP address                                                                       </P
11614 ></LI
11615 ></UL
11616 ></LI
11617 ><LI
11618 ><P
11619 >&#13;                                                          <CODE
11620 CLASS="parameter"
11621 >type</CODE
11622 >
11623 : string or array of string                                                     </P
11624 ><P
11625 ></P
11626 ><UL
11627 ><LI
11628 ><P
11629 >&#13;string, Address type (e.g., 'ipv4')                                                                       </P
11630 ></LI
11631 ><LI
11632 ><P
11633 >&#13;array of string, Address type (e.g., 'ipv4')                                                                      </P
11634 ></LI
11635 ></UL
11636 ></LI
11637 ><LI
11638 ><P
11639 >&#13;                                                          <CODE
11640 CLASS="parameter"
11641 >gateway</CODE
11642 >
11643 : string or array of string                                                     </P
11644 ><P
11645 ></P
11646 ><UL
11647 ><LI
11648 ><P
11649 >&#13;string, IP address of primary gateway                                                                     </P
11650 ></LI
11651 ><LI
11652 ><P
11653 >&#13;array of string, IP address of primary gateway                                                                    </P
11654 ></LI
11655 ></UL
11656 ></LI
11657 ></UL
11658 ></LI
11659 ></UL
11660 ></LI
11661 ><LI
11662 ><P
11663 >&#13;                          <CODE
11664 CLASS="parameter"
11665 >return_fields</CODE
11666 >
11667 : array, List of fields to return                       </P
11668 ><P
11669 ></P
11670 ><UL
11671 ><LI
11672 ><P
11673 >&#13;string                                    </P
11674 ></LI
11675 ></UL
11676 ></LI
11677 ></UL
11678 ><P
11679 >Returns:</P
11680 ><P
11681 ></P
11682 ><UL
11683 ><LI
11684 ><P
11685 >&#13;array of struct                   </P
11686 ><P
11687 ></P
11688 ><UL
11689 ><LI
11690 ><P
11691 >&#13;                                          <CODE
11692 CLASS="parameter"
11693 >broadcast</CODE
11694 >
11695 : string, Network broadcast address                                     </P
11696 ></LI
11697 ><LI
11698 ><P
11699 >&#13;                                          <CODE
11700 CLASS="parameter"
11701 >is_primary</CODE
11702 >
11703 : boolean, Is the primary interface for this node                                       </P
11704 ></LI
11705 ><LI
11706 ><P
11707 >&#13;                                          <CODE
11708 CLASS="parameter"
11709 >network</CODE
11710 >
11711 : string, Subnet address                                        </P
11712 ></LI
11713 ><LI
11714 ><P
11715 >&#13;                                          <CODE
11716 CLASS="parameter"
11717 >ip</CODE
11718 >
11719 : string, IP address                                    </P
11720 ></LI
11721 ><LI
11722 ><P
11723 >&#13;                                          <CODE
11724 CLASS="parameter"
11725 >dns1</CODE
11726 >
11727 : string, IP address of primary DNS server                                      </P
11728 ></LI
11729 ><LI
11730 ><P
11731 >&#13;                                          <CODE
11732 CLASS="parameter"
11733 >hostname</CODE
11734 >
11735 : string, (Optional) Hostname                                   </P
11736 ></LI
11737 ><LI
11738 ><P
11739 >&#13;                                          <CODE
11740 CLASS="parameter"
11741 >netmask</CODE
11742 >
11743 : string, Subnet mask                                   </P
11744 ></LI
11745 ><LI
11746 ><P
11747 >&#13;                                          <CODE
11748 CLASS="parameter"
11749 >gateway</CODE
11750 >
11751 : string, IP address of primary gateway                                 </P
11752 ></LI
11753 ><LI
11754 ><P
11755 >&#13;                                          <CODE
11756 CLASS="parameter"
11757 >nodenetwork_id</CODE
11758 >
11759 : int, Node interface identifier                                        </P
11760 ></LI
11761 ><LI
11762 ><P
11763 >&#13;                                          <CODE
11764 CLASS="parameter"
11765 >mac</CODE
11766 >
11767 : string, MAC address                                   </P
11768 ></LI
11769 ><LI
11770 ><P
11771 >&#13;                                          <CODE
11772 CLASS="parameter"
11773 >node_id</CODE
11774 >
11775 : int, Node associated with this interface                                      </P
11776 ></LI
11777 ><LI
11778 ><P
11779 >&#13;                                          <CODE
11780 CLASS="parameter"
11781 >dns2</CODE
11782 >
11783 : string, IP address of secondary DNS server                                    </P
11784 ></LI
11785 ><LI
11786 ><P
11787 >&#13;                                          <CODE
11788 CLASS="parameter"
11789 >bwlimit</CODE
11790 >
11791 : int, Bandwidth limit                                  </P
11792 ></LI
11793 ><LI
11794 ><P
11795 >&#13;                                          <CODE
11796 CLASS="parameter"
11797 >type</CODE
11798 >
11799 : string, Address type (e.g., 'ipv4')                                   </P
11800 ></LI
11801 ><LI
11802 ><P
11803 >&#13;                                          <CODE
11804 CLASS="parameter"
11805 >method</CODE
11806 >
11807 : string, Addressing method (e.g., 'static' or 'dhcp')                                  </P
11808 ></LI
11809 ></UL
11810 ></LI
11811 ></UL
11812 ></DIV
11813 ><DIV
11814 CLASS="section"
11815 ><HR><H2
11816 CLASS="section"
11817 ><A
11818 NAME="GetNodes"
11819 >2.79. GetNodes</A
11820 ></H2
11821 ><P
11822 >Prototype:<A
11823 NAME="AEN3829"
11824 ></A
11825 ><BLOCKQUOTE
11826 CLASS="BLOCKQUOTE"
11827 ><P
11828 >GetNodes (auth, node_filter, return_fields)</P
11829 ></BLOCKQUOTE
11830 ></P
11831 ><P
11832 >Description:<A
11833 NAME="AEN3832"
11834 ></A
11835 ><BLOCKQUOTE
11836 CLASS="BLOCKQUOTE"
11837 ><P
11838 >Returns an array of structs containing details about nodes. If
11839 node_filter is specified and is an array of node identifiers or
11840 hostnames, or a struct of node attributes, only nodes matching the
11841 filter will be returned. If return_fields is specified, only the
11842 specified details will be returned.</P
11843 ><P
11844 >Some fields may only be viewed by admins.</P
11845 ></BLOCKQUOTE
11846 ></P
11847 ><P
11848 >Allowed Roles:<A
11849 NAME="AEN3836"
11850 ></A
11851 ><BLOCKQUOTE
11852 CLASS="BLOCKQUOTE"
11853 ><P
11854 >admin, pi, user, tech, node, anonymous</P
11855 ></BLOCKQUOTE
11856 ></P
11857 ><P
11858 >Parameters:</P
11859 ><P
11860 ></P
11861 ><UL
11862 ><LI
11863 ><P
11864 >&#13;                          <CODE
11865 CLASS="parameter"
11866 >auth</CODE
11867 >
11868 : struct, API authentication structure                  </P
11869 ><P
11870 ></P
11871 ><UL
11872 ><LI
11873 ><P
11874 >&#13;                                          <CODE
11875 CLASS="parameter"
11876 >AuthMethod</CODE
11877 >
11878 : string, Authentication method to use                                  </P
11879 ></LI
11880 ></UL
11881 ></LI
11882 ><LI
11883 ><P
11884 >&#13;                          <CODE
11885 CLASS="parameter"
11886 >node_filter</CODE
11887 >
11888 : array of int or string or struct                      </P
11889 ><P
11890 ></P
11891 ><UL
11892 ><LI
11893 ><P
11894 >&#13;array of int or string                                    </P
11895 ><P
11896 ></P
11897 ><UL
11898 ><LI
11899 ><P
11900 >&#13;int, Node identifier                                                      </P
11901 ></LI
11902 ><LI
11903 ><P
11904 >&#13;string, Fully qualified hostname                                                  </P
11905 ></LI
11906 ></UL
11907 ></LI
11908 ><LI
11909 ><P
11910 >&#13;struct, Attribute filter                                  </P
11911 ><P
11912 ></P
11913 ><UL
11914 ><LI
11915 ><P
11916 >&#13;                                                          <CODE
11917 CLASS="parameter"
11918 >last_updated</CODE
11919 >
11920 : int or array of int                                                   </P
11921 ><P
11922 ></P
11923 ><UL
11924 ><LI
11925 ><P
11926 >&#13;int, Date and time when node entry was created                                                                    </P
11927 ></LI
11928 ><LI
11929 ><P
11930 >&#13;array of int, Date and time when node entry was created                                                                   </P
11931 ></LI
11932 ></UL
11933 ></LI
11934 ><LI
11935 ><P
11936 >&#13;                                                          <CODE
11937 CLASS="parameter"
11938 >version</CODE
11939 >
11940 : string or array of string                                                     </P
11941 ><P
11942 ></P
11943 ><UL
11944 ><LI
11945 ><P
11946 >&#13;string, Apparent Boot CD version                                                                  </P
11947 ></LI
11948 ><LI
11949 ><P
11950 >&#13;array of string, Apparent Boot CD version                                                                 </P
11951 ></LI
11952 ></UL
11953 ></LI
11954 ><LI
11955 ><P
11956 >&#13;                                                          <CODE
11957 CLASS="parameter"
11958 >boot_state</CODE
11959 >
11960 : string or array of string                                                     </P
11961 ><P
11962 ></P
11963 ><UL
11964 ><LI
11965 ><P
11966 >&#13;string, Boot state                                                                        </P
11967 ></LI
11968 ><LI
11969 ><P
11970 >&#13;array of string, Boot state                                                                       </P
11971 ></LI
11972 ></UL
11973 ></LI
11974 ><LI
11975 ><P
11976 >&#13;                                                          <CODE
11977 CLASS="parameter"
11978 >peer_node_id</CODE
11979 >
11980 : int or array of int                                                   </P
11981 ><P
11982 ></P
11983 ><UL
11984 ><LI
11985 ><P
11986 >&#13;int, Foreign node identifier at peer                                                                      </P
11987 ></LI
11988 ><LI
11989 ><P
11990 >&#13;array of int, Foreign node identifier at peer                                                                     </P
11991 ></LI
11992 ></UL
11993 ></LI
11994 ><LI
11995 ><P
11996 >&#13;                                                          <CODE
11997 CLASS="parameter"
11998 >hostname</CODE
11999 >
12000 : string or array of string                                                     </P
12001 ><P
12002 ></P
12003 ><UL
12004 ><LI
12005 ><P
12006 >&#13;string, Fully qualified hostname                                                                  </P
12007 ></LI
12008 ><LI
12009 ><P
12010 >&#13;array of string, Fully qualified hostname                                                                 </P
12011 ></LI
12012 ></UL
12013 ></LI
12014 ><LI
12015 ><P
12016 >&#13;                                                          <CODE
12017 CLASS="parameter"
12018 >site_id</CODE
12019 >
12020 : int or array of int                                                   </P
12021 ><P
12022 ></P
12023 ><UL
12024 ><LI
12025 ><P
12026 >&#13;int, Site at which this node is located                                                                   </P
12027 ></LI
12028 ><LI
12029 ><P
12030 >&#13;array of int, Site at which this node is located                                                                  </P
12031 ></LI
12032 ></UL
12033 ></LI
12034 ><LI
12035 ><P
12036 >&#13;                                                          <CODE
12037 CLASS="parameter"
12038 >boot_nonce</CODE
12039 >
12040 : string or array of string                                                     </P
12041 ><P
12042 ></P
12043 ><UL
12044 ><LI
12045 ><P
12046 >&#13;string, (Admin only) Random value generated by the node at last boot                                                                      </P
12047 ></LI
12048 ><LI
12049 ><P
12050 >&#13;array of string, (Admin only) Random value generated by the node at last boot                                                                     </P
12051 ></LI
12052 ></UL
12053 ></LI
12054 ><LI
12055 ><P
12056 >&#13;                                                          <CODE
12057 CLASS="parameter"
12058 >session</CODE
12059 >
12060 : string or array of string                                                     </P
12061 ><P
12062 ></P
12063 ><UL
12064 ><LI
12065 ><P
12066 >&#13;string, (Admin only) Node session value                                                                   </P
12067 ></LI
12068 ><LI
12069 ><P
12070 >&#13;array of string, (Admin only) Node session value                                                                  </P
12071 ></LI
12072 ></UL
12073 ></LI
12074 ><LI
12075 ><P
12076 >&#13;                                                          <CODE
12077 CLASS="parameter"
12078 >ssh_rsa_key</CODE
12079 >
12080 : string or array of string                                                     </P
12081 ><P
12082 ></P
12083 ><UL
12084 ><LI
12085 ><P
12086 >&#13;string, Last known SSH host key                                                                   </P
12087 ></LI
12088 ><LI
12089 ><P
12090 >&#13;array of string, Last known SSH host key                                                                  </P
12091 ></LI
12092 ></UL
12093 ></LI
12094 ><LI
12095 ><P
12096 >&#13;                                                          <CODE
12097 CLASS="parameter"
12098 >key</CODE
12099 >
12100 : string or array of string                                                     </P
12101 ><P
12102 ></P
12103 ><UL
12104 ><LI
12105 ><P
12106 >&#13;string, (Admin only) Node key                                                                     </P
12107 ></LI
12108 ><LI
12109 ><P
12110 >&#13;array of string, (Admin only) Node key                                                                    </P
12111 ></LI
12112 ></UL
12113 ></LI
12114 ><LI
12115 ><P
12116 >&#13;                                                          <CODE
12117 CLASS="parameter"
12118 >date_created</CODE
12119 >
12120 : int or array of int                                                   </P
12121 ><P
12122 ></P
12123 ><UL
12124 ><LI
12125 ><P
12126 >&#13;int, Date and time when node entry was created                                                                    </P
12127 ></LI
12128 ><LI
12129 ><P
12130 >&#13;array of int, Date and time when node entry was created                                                                   </P
12131 ></LI
12132 ></UL
12133 ></LI
12134 ><LI
12135 ><P
12136 >&#13;                                                          <CODE
12137 CLASS="parameter"
12138 >model</CODE
12139 >
12140 : string or array of string                                                     </P
12141 ><P
12142 ></P
12143 ><UL
12144 ><LI
12145 ><P
12146 >&#13;string, Make and model of the actual machine                                                                      </P
12147 ></LI
12148 ><LI
12149 ><P
12150 >&#13;array of string, Make and model of the actual machine                                                                     </P
12151 ></LI
12152 ></UL
12153 ></LI
12154 ><LI
12155 ><P
12156 >&#13;                                                          <CODE
12157 CLASS="parameter"
12158 >peer_id</CODE
12159 >
12160 : int or array of int                                                   </P
12161 ><P
12162 ></P
12163 ><UL
12164 ><LI
12165 ><P
12166 >&#13;int, Peer to which this node belongs                                                                      </P
12167 ></LI
12168 ><LI
12169 ><P
12170 >&#13;array of int, Peer to which this node belongs                                                                     </P
12171 ></LI
12172 ></UL
12173 ></LI
12174 ><LI
12175 ><P
12176 >&#13;                                                          <CODE
12177 CLASS="parameter"
12178 >node_id</CODE
12179 >
12180 : int or array of int                                                   </P
12181 ><P
12182 ></P
12183 ><UL
12184 ><LI
12185 ><P
12186 >&#13;int, Node identifier                                                                      </P
12187 ></LI
12188 ><LI
12189 ><P
12190 >&#13;array of int, Node identifier                                                                     </P
12191 ></LI
12192 ></UL
12193 ></LI
12194 ></UL
12195 ></LI
12196 ></UL
12197 ></LI
12198 ><LI
12199 ><P
12200 >&#13;                          <CODE
12201 CLASS="parameter"
12202 >return_fields</CODE
12203 >
12204 : array, List of fields to return                       </P
12205 ><P
12206 ></P
12207 ><UL
12208 ><LI
12209 ><P
12210 >&#13;string                                    </P
12211 ></LI
12212 ></UL
12213 ></LI
12214 ></UL
12215 ><P
12216 >Returns:</P
12217 ><P
12218 ></P
12219 ><UL
12220 ><LI
12221 ><P
12222 >&#13;array of struct                   </P
12223 ><P
12224 ></P
12225 ><UL
12226 ><LI
12227 ><P
12228 >&#13;                                          <CODE
12229 CLASS="parameter"
12230 >session</CODE
12231 >
12232 : string, (Admin only) Node session value                                       </P
12233 ></LI
12234 ><LI
12235 ><P
12236 >&#13;                                          <CODE
12237 CLASS="parameter"
12238 >pcu_ids</CODE
12239 >
12240 : array, List of PCUs that control this node                                    </P
12241 ><P
12242 ></P
12243 ><UL
12244 ><LI
12245 ><P
12246 >&#13;int                                                       </P
12247 ></LI
12248 ></UL
12249 ></LI
12250 ><LI
12251 ><P
12252 >&#13;                                          <CODE
12253 CLASS="parameter"
12254 >nodegroup_ids</CODE
12255 >
12256 : array, List of node groups that this node is in                                       </P
12257 ><P
12258 ></P
12259 ><UL
12260 ><LI
12261 ><P
12262 >&#13;int                                                       </P
12263 ></LI
12264 ></UL
12265 ></LI
12266 ><LI
12267 ><P
12268 >&#13;                                          <CODE
12269 CLASS="parameter"
12270 >last_updated</CODE
12271 >
12272 : int, Date and time when node entry was created                                        </P
12273 ></LI
12274 ><LI
12275 ><P
12276 >&#13;                                          <CODE
12277 CLASS="parameter"
12278 >version</CODE
12279 >
12280 : string, Apparent Boot CD version                                      </P
12281 ></LI
12282 ><LI
12283 ><P
12284 >&#13;                                          <CODE
12285 CLASS="parameter"
12286 >nodenetwork_ids</CODE
12287 >
12288 : array, List of network interfaces that this node has                                  </P
12289 ><P
12290 ></P
12291 ><UL
12292 ><LI
12293 ><P
12294 >&#13;int                                                       </P
12295 ></LI
12296 ></UL
12297 ></LI
12298 ><LI
12299 ><P
12300 >&#13;                                          <CODE
12301 CLASS="parameter"
12302 >boot_state</CODE
12303 >
12304 : string, Boot state                                    </P
12305 ></LI
12306 ><LI
12307 ><P
12308 >&#13;                                          <CODE
12309 CLASS="parameter"
12310 >peer_node_id</CODE
12311 >
12312 : int, Foreign node identifier at peer                                  </P
12313 ></LI
12314 ><LI
12315 ><P
12316 >&#13;                                          <CODE
12317 CLASS="parameter"
12318 >hostname</CODE
12319 >
12320 : string, Fully qualified hostname                                      </P
12321 ></LI
12322 ><LI
12323 ><P
12324 >&#13;                                          <CODE
12325 CLASS="parameter"
12326 >site_id</CODE
12327 >
12328 : int, Site at which this node is located                                       </P
12329 ></LI
12330 ><LI
12331 ><P
12332 >&#13;                                          <CODE
12333 CLASS="parameter"
12334 >ports</CODE
12335 >
12336 : array, List of PCU ports that this node is connected to                                       </P
12337 ><P
12338 ></P
12339 ><UL
12340 ><LI
12341 ><P
12342 >&#13;int                                                       </P
12343 ></LI
12344 ></UL
12345 ></LI
12346 ><LI
12347 ><P
12348 >&#13;                                          <CODE
12349 CLASS="parameter"
12350 >slice_ids</CODE
12351 >
12352 : array, List of slices on this node                                    </P
12353 ><P
12354 ></P
12355 ><UL
12356 ><LI
12357 ><P
12358 >&#13;int                                                       </P
12359 ></LI
12360 ></UL
12361 ></LI
12362 ><LI
12363 ><P
12364 >&#13;                                          <CODE
12365 CLASS="parameter"
12366 >boot_nonce</CODE
12367 >
12368 : string, (Admin only) Random value generated by the node at last boot                                  </P
12369 ></LI
12370 ><LI
12371 ><P
12372 >&#13;                                          <CODE
12373 CLASS="parameter"
12374 >node_id</CODE
12375 >
12376 : int, Node identifier                                  </P
12377 ></LI
12378 ><LI
12379 ><P
12380 >&#13;                                          <CODE
12381 CLASS="parameter"
12382 >key</CODE
12383 >
12384 : string, (Admin only) Node key                                 </P
12385 ></LI
12386 ><LI
12387 ><P
12388 >&#13;                                          <CODE
12389 CLASS="parameter"
12390 >date_created</CODE
12391 >
12392 : int, Date and time when node entry was created                                        </P
12393 ></LI
12394 ><LI
12395 ><P
12396 >&#13;                                          <CODE
12397 CLASS="parameter"
12398 >model</CODE
12399 >
12400 : string, Make and model of the actual machine                                  </P
12401 ></LI
12402 ><LI
12403 ><P
12404 >&#13;                                          <CODE
12405 CLASS="parameter"
12406 >peer_id</CODE
12407 >
12408 : int, Peer to which this node belongs                                  </P
12409 ></LI
12410 ><LI
12411 ><P
12412 >&#13;                                          <CODE
12413 CLASS="parameter"
12414 >conf_file_ids</CODE
12415 >
12416 : array, List of configuration files specific to this node                                      </P
12417 ><P
12418 ></P
12419 ><UL
12420 ><LI
12421 ><P
12422 >&#13;int                                                       </P
12423 ></LI
12424 ></UL
12425 ></LI
12426 ><LI
12427 ><P
12428 >&#13;                                          <CODE
12429 CLASS="parameter"
12430 >ssh_rsa_key</CODE
12431 >
12432 : string, Last known SSH host key                                       </P
12433 ></LI
12434 ></UL
12435 ></LI
12436 ></UL
12437 ></DIV
12438 ><DIV
12439 CLASS="section"
12440 ><HR><H2
12441 CLASS="section"
12442 ><A
12443 NAME="GetPCUs"
12444 >2.80. GetPCUs</A
12445 ></H2
12446 ><P
12447 >Prototype:<A
12448 NAME="AEN4065"
12449 ></A
12450 ><BLOCKQUOTE
12451 CLASS="BLOCKQUOTE"
12452 ><P
12453 >GetPCUs (auth, pcu_filter, return_fields)</P
12454 ></BLOCKQUOTE
12455 ></P
12456 ><P
12457 >Description:<A
12458 NAME="AEN4068"
12459 ></A
12460 ><BLOCKQUOTE
12461 CLASS="BLOCKQUOTE"
12462 ><P
12463 >Returns an array of structs containing details about power control
12464 units (PCUs). If pcu_filter is specified and is an array of PCU
12465 identifiers, or a struct of PCU attributes, only PCUs matching the
12466 filter will be returned. If return_fields is specified, only the
12467 specified details will be returned.</P
12468 ><P
12469 >Admin may query all PCUs. Non-admins may only query the PCUs at
12470 their sites.</P
12471 ></BLOCKQUOTE
12472 ></P
12473 ><P
12474 >Allowed Roles:<A
12475 NAME="AEN4072"
12476 ></A
12477 ><BLOCKQUOTE
12478 CLASS="BLOCKQUOTE"
12479 ><P
12480 >admin, pi, tech, node</P
12481 ></BLOCKQUOTE
12482 ></P
12483 ><P
12484 >Parameters:</P
12485 ><P
12486 ></P
12487 ><UL
12488 ><LI
12489 ><P
12490 >&#13;                          <CODE
12491 CLASS="parameter"
12492 >auth</CODE
12493 >
12494 : struct, API authentication structure                  </P
12495 ><P
12496 ></P
12497 ><UL
12498 ><LI
12499 ><P
12500 >&#13;                                          <CODE
12501 CLASS="parameter"
12502 >AuthMethod</CODE
12503 >
12504 : string, Authentication method to use                                  </P
12505 ></LI
12506 ></UL
12507 ></LI
12508 ><LI
12509 ><P
12510 >&#13;                          <CODE
12511 CLASS="parameter"
12512 >pcu_filter</CODE
12513 >
12514 : array of int or struct                        </P
12515 ><P
12516 ></P
12517 ><UL
12518 ><LI
12519 ><P
12520 >&#13;array of int, PCU identifier                                      </P
12521 ></LI
12522 ><LI
12523 ><P
12524 >&#13;struct, Attribute filter                                  </P
12525 ><P
12526 ></P
12527 ><UL
12528 ><LI
12529 ><P
12530 >&#13;                                                          <CODE
12531 CLASS="parameter"
12532 >username</CODE
12533 >
12534 : string or array of string                                                     </P
12535 ><P
12536 ></P
12537 ><UL
12538 ><LI
12539 ><P
12540 >&#13;string, PCU username                                                                      </P
12541 ></LI
12542 ><LI
12543 ><P
12544 >&#13;array of string, PCU username                                                                     </P
12545 ></LI
12546 ></UL
12547 ></LI
12548 ><LI
12549 ><P
12550 >&#13;                                                          <CODE
12551 CLASS="parameter"
12552 >protocol</CODE
12553 >
12554 : string or array of string                                                     </P
12555 ><P
12556 ></P
12557 ><UL
12558 ><LI
12559 ><P
12560 >&#13;string, PCU protocol, e.g. ssh, https, telnet                                                                     </P
12561 ></LI
12562 ><LI
12563 ><P
12564 >&#13;array of string, PCU protocol, e.g. ssh, https, telnet                                                                    </P
12565 ></LI
12566 ></UL
12567 ></LI
12568 ><LI
12569 ><P
12570 >&#13;                                                          <CODE
12571 CLASS="parameter"
12572 >ip</CODE
12573 >
12574 : string or array of string                                                     </P
12575 ><P
12576 ></P
12577 ><UL
12578 ><LI
12579 ><P
12580 >&#13;string, PCU IP address                                                                    </P
12581 ></LI
12582 ><LI
12583 ><P
12584 >&#13;array of string, PCU IP address                                                                   </P
12585 ></LI
12586 ></UL
12587 ></LI
12588 ><LI
12589 ><P
12590 >&#13;                                                          <CODE
12591 CLASS="parameter"
12592 >pcu_id</CODE
12593 >
12594 : int or array of int                                                   </P
12595 ><P
12596 ></P
12597 ><UL
12598 ><LI
12599 ><P
12600 >&#13;int, PCU identifier                                                                       </P
12601 ></LI
12602 ><LI
12603 ><P
12604 >&#13;array of int, PCU identifier                                                                      </P
12605 ></LI
12606 ></UL
12607 ></LI
12608 ><LI
12609 ><P
12610 >&#13;                                                          <CODE
12611 CLASS="parameter"
12612 >hostname</CODE
12613 >
12614 : string or array of string                                                     </P
12615 ><P
12616 ></P
12617 ><UL
12618 ><LI
12619 ><P
12620 >&#13;string, PCU hostname                                                                      </P
12621 ></LI
12622 ><LI
12623 ><P
12624 >&#13;array of string, PCU hostname                                                                     </P
12625 ></LI
12626 ></UL
12627 ></LI
12628 ><LI
12629 ><P
12630 >&#13;                                                          <CODE
12631 CLASS="parameter"
12632 >site_id</CODE
12633 >
12634 : int or array of int                                                   </P
12635 ><P
12636 ></P
12637 ><UL
12638 ><LI
12639 ><P
12640 >&#13;int, Identifier of site where PCU is located                                                                      </P
12641 ></LI
12642 ><LI
12643 ><P
12644 >&#13;array of int, Identifier of site where PCU is located                                                                     </P
12645 ></LI
12646 ></UL
12647 ></LI
12648 ><LI
12649 ><P
12650 >&#13;                                                          <CODE
12651 CLASS="parameter"
12652 >model</CODE
12653 >
12654 : string or array of string                                                     </P
12655 ><P
12656 ></P
12657 ><UL
12658 ><LI
12659 ><P
12660 >&#13;string, PCU model string                                                                  </P
12661 ></LI
12662 ><LI
12663 ><P
12664 >&#13;array of string, PCU model string                                                                 </P
12665 ></LI
12666 ></UL
12667 ></LI
12668 ><LI
12669 ><P
12670 >&#13;                                                          <CODE
12671 CLASS="parameter"
12672 >password</CODE
12673 >
12674 : string or array of string                                                     </P
12675 ><P
12676 ></P
12677 ><UL
12678 ><LI
12679 ><P
12680 >&#13;string, PCU username                                                                      </P
12681 ></LI
12682 ><LI
12683 ><P
12684 >&#13;array of string, PCU username                                                                     </P
12685 ></LI
12686 ></UL
12687 ></LI
12688 ><LI
12689 ><P
12690 >&#13;                                                          <CODE
12691 CLASS="parameter"
12692 >notes</CODE
12693 >
12694 : string or array of string                                                     </P
12695 ><P
12696 ></P
12697 ><UL
12698 ><LI
12699 ><P
12700 >&#13;string, Miscellaneous notes                                                                       </P
12701 ></LI
12702 ><LI
12703 ><P
12704 >&#13;array of string, Miscellaneous notes                                                                      </P
12705 ></LI
12706 ></UL
12707 ></LI
12708 ></UL
12709 ></LI
12710 ></UL
12711 ></LI
12712 ><LI
12713 ><P
12714 >&#13;                          <CODE
12715 CLASS="parameter"
12716 >return_fields</CODE
12717 >
12718 : array, List of fields to return                       </P
12719 ><P
12720 ></P
12721 ><UL
12722 ><LI
12723 ><P
12724 >&#13;string                                    </P
12725 ></LI
12726 ></UL
12727 ></LI
12728 ></UL
12729 ><P
12730 >Returns:</P
12731 ><P
12732 ></P
12733 ><UL
12734 ><LI
12735 ><P
12736 >&#13;array of struct                   </P
12737 ><P
12738 ></P
12739 ><UL
12740 ><LI
12741 ><P
12742 >&#13;                                          <CODE
12743 CLASS="parameter"
12744 >username</CODE
12745 >
12746 : string, PCU username                                  </P
12747 ></LI
12748 ><LI
12749 ><P
12750 >&#13;                                          <CODE
12751 CLASS="parameter"
12752 >protocol</CODE
12753 >
12754 : string, PCU protocol, e.g. ssh, https, telnet                                 </P
12755 ></LI
12756 ><LI
12757 ><P
12758 >&#13;                                          <CODE
12759 CLASS="parameter"
12760 >node_ids</CODE
12761 >
12762 : array, List of nodes that this PCU controls                                   </P
12763 ><P
12764 ></P
12765 ><UL
12766 ><LI
12767 ><P
12768 >&#13;int                                                       </P
12769 ></LI
12770 ></UL
12771 ></LI
12772 ><LI
12773 ><P
12774 >&#13;                                          <CODE
12775 CLASS="parameter"
12776 >ip</CODE
12777 >
12778 : string, PCU IP address                                        </P
12779 ></LI
12780 ><LI
12781 ><P
12782 >&#13;                                          <CODE
12783 CLASS="parameter"
12784 >pcu_id</CODE
12785 >
12786 : int, PCU identifier                                   </P
12787 ></LI
12788 ><LI
12789 ><P
12790 >&#13;                                          <CODE
12791 CLASS="parameter"
12792 >hostname</CODE
12793 >
12794 : string, PCU hostname                                  </P
12795 ></LI
12796 ><LI
12797 ><P
12798 >&#13;                                          <CODE
12799 CLASS="parameter"
12800 >site_id</CODE
12801 >
12802 : int, Identifier of site where PCU is located                                  </P
12803 ></LI
12804 ><LI
12805 ><P
12806 >&#13;                                          <CODE
12807 CLASS="parameter"
12808 >ports</CODE
12809 >
12810 : array, List of the port numbers that each node is connected to                                        </P
12811 ><P
12812 ></P
12813 ><UL
12814 ><LI
12815 ><P
12816 >&#13;int                                                       </P
12817 ></LI
12818 ></UL
12819 ></LI
12820 ><LI
12821 ><P
12822 >&#13;                                          <CODE
12823 CLASS="parameter"
12824 >model</CODE
12825 >
12826 : string, PCU model string                                      </P
12827 ></LI
12828 ><LI
12829 ><P
12830 >&#13;                                          <CODE
12831 CLASS="parameter"
12832 >password</CODE
12833 >
12834 : string, PCU username                                  </P
12835 ></LI
12836 ><LI
12837 ><P
12838 >&#13;                                          <CODE
12839 CLASS="parameter"
12840 >notes</CODE
12841 >
12842 : string, Miscellaneous notes                                   </P
12843 ></LI
12844 ></UL
12845 ></LI
12846 ></UL
12847 ></DIV
12848 ><DIV
12849 CLASS="section"
12850 ><HR><H2
12851 CLASS="section"
12852 ><A
12853 NAME="GetPeerData"
12854 >2.81. GetPeerData</A
12855 ></H2
12856 ><P
12857 >Prototype:<A
12858 NAME="AEN4217"
12859 ></A
12860 ><BLOCKQUOTE
12861 CLASS="BLOCKQUOTE"
12862 ><P
12863 >GetPeerData (auth)</P
12864 ></BLOCKQUOTE
12865 ></P
12866 ><P
12867 >Description:<A
12868 NAME="AEN4220"
12869 ></A
12870 ><BLOCKQUOTE
12871 CLASS="BLOCKQUOTE"
12872 ><P
12873 >Returns lists of local objects that a peer should cache in its
12874 database as foreign objects. Also returns the list of foreign
12875 nodes in this database, for which the calling peer is
12876 authoritative, to assist in synchronization of slivers.</P
12877 ><P
12878 >See the implementation of RefreshPeer for how this data is used.</P
12879 ></BLOCKQUOTE
12880 ></P
12881 ><P
12882 >Allowed Roles:<A
12883 NAME="AEN4224"
12884 ></A
12885 ><BLOCKQUOTE
12886 CLASS="BLOCKQUOTE"
12887 ><P
12888 >admin, peer</P
12889 ></BLOCKQUOTE
12890 ></P
12891 ><P
12892 >Parameters:</P
12893 ><P
12894 ></P
12895 ><UL
12896 ><LI
12897 ><P
12898 >&#13;                          <CODE
12899 CLASS="parameter"
12900 >auth</CODE
12901 >
12902 : struct, API authentication structure                  </P
12903 ><P
12904 ></P
12905 ><UL
12906 ><LI
12907 ><P
12908 >&#13;                                          <CODE
12909 CLASS="parameter"
12910 >AuthMethod</CODE
12911 >
12912 : string, Authentication method to use                                  </P
12913 ></LI
12914 ></UL
12915 ></LI
12916 ></UL
12917 ><P
12918 >Returns:</P
12919 ><P
12920 ></P
12921 ><UL
12922 ><LI
12923 ><P
12924 >&#13;struct                    </P
12925 ><P
12926 ></P
12927 ><UL
12928 ><LI
12929 ><P
12930 >&#13;                                          <CODE
12931 CLASS="parameter"
12932 >Slices</CODE
12933 >
12934 : array, List of local slices                                   </P
12935 ><P
12936 ></P
12937 ><UL
12938 ><LI
12939 ><P
12940 >&#13;struct                                                    </P
12941 ></LI
12942 ></UL
12943 ></LI
12944 ><LI
12945 ><P
12946 >&#13;                                          <CODE
12947 CLASS="parameter"
12948 >Keys</CODE
12949 >
12950 : array, List of local keys                                     </P
12951 ><P
12952 ></P
12953 ><UL
12954 ><LI
12955 ><P
12956 >&#13;struct                                                    </P
12957 ></LI
12958 ></UL
12959 ></LI
12960 ><LI
12961 ><P
12962 >&#13;                                          <CODE
12963 CLASS="parameter"
12964 >Sites</CODE
12965 >
12966 : array, List of local sites                                    </P
12967 ><P
12968 ></P
12969 ><UL
12970 ><LI
12971 ><P
12972 >&#13;struct                                                    </P
12973 ></LI
12974 ></UL
12975 ></LI
12976 ><LI
12977 ><P
12978 >&#13;                                          <CODE
12979 CLASS="parameter"
12980 >Persons</CODE
12981 >
12982 : array, List of local users                                    </P
12983 ><P
12984 ></P
12985 ><UL
12986 ><LI
12987 ><P
12988 >&#13;struct                                                    </P
12989 ></LI
12990 ></UL
12991 ></LI
12992 ><LI
12993 ><P
12994 >&#13;                                          <CODE
12995 CLASS="parameter"
12996 >Nodes</CODE
12997 >
12998 : array, List of local nodes                                    </P
12999 ><P
13000 ></P
13001 ><UL
13002 ><LI
13003 ><P
13004 >&#13;struct                                                    </P
13005 ></LI
13006 ></UL
13007 ></LI
13008 ><LI
13009 ><P
13010 >&#13;                                          <CODE
13011 CLASS="parameter"
13012 >db_time</CODE
13013 >
13014 : double, (Debug) Database fetch time                                   </P
13015 ></LI
13016 ></UL
13017 ></LI
13018 ></UL
13019 ></DIV
13020 ><DIV
13021 CLASS="section"
13022 ><HR><H2
13023 CLASS="section"
13024 ><A
13025 NAME="GetPeerName"
13026 >2.82. GetPeerName</A
13027 ></H2
13028 ><P
13029 >Prototype:<A
13030 NAME="AEN4276"
13031 ></A
13032 ><BLOCKQUOTE
13033 CLASS="BLOCKQUOTE"
13034 ><P
13035 >GetPeerName (auth)</P
13036 ></BLOCKQUOTE
13037 ></P
13038 ><P
13039 >Description:<A
13040 NAME="AEN4279"
13041 ></A
13042 ><BLOCKQUOTE
13043 CLASS="BLOCKQUOTE"
13044 ><P
13045 >Returns this peer's name, as defined in the config as PLC_NAME</P
13046 ></BLOCKQUOTE
13047 ></P
13048 ><P
13049 >Allowed Roles:<A
13050 NAME="AEN4282"
13051 ></A
13052 ><BLOCKQUOTE
13053 CLASS="BLOCKQUOTE"
13054 ><P
13055 >admin, peer, node</P
13056 ></BLOCKQUOTE
13057 ></P
13058 ><P
13059 >Parameters:</P
13060 ><P
13061 ></P
13062 ><UL
13063 ><LI
13064 ><P
13065 >&#13;                          <CODE
13066 CLASS="parameter"
13067 >auth</CODE
13068 >
13069 : struct, API authentication structure                  </P
13070 ><P
13071 ></P
13072 ><UL
13073 ><LI
13074 ><P
13075 >&#13;                                          <CODE
13076 CLASS="parameter"
13077 >AuthMethod</CODE
13078 >
13079 : string, Authentication method to use                                  </P
13080 ></LI
13081 ></UL
13082 ></LI
13083 ></UL
13084 ><P
13085 >Returns:</P
13086 ><P
13087 ></P
13088 ><UL
13089 ><LI
13090 ><P
13091 >&#13;string, Peer name                 </P
13092 ></LI
13093 ></UL
13094 ></DIV
13095 ><DIV
13096 CLASS="section"
13097 ><HR><H2
13098 CLASS="section"
13099 ><A
13100 NAME="GetPeers"
13101 >2.83. GetPeers</A
13102 ></H2
13103 ><P
13104 >Prototype:<A
13105 NAME="AEN4300"
13106 ></A
13107 ><BLOCKQUOTE
13108 CLASS="BLOCKQUOTE"
13109 ><P
13110 >GetPeers (auth, peer_filter, return_fields)</P
13111 ></BLOCKQUOTE
13112 ></P
13113 ><P
13114 >Description:<A
13115 NAME="AEN4303"
13116 ></A
13117 ><BLOCKQUOTE
13118 CLASS="BLOCKQUOTE"
13119 ><P
13120 >Returns an array of structs containing details about peers. If
13121 person_filter is specified and is an array of peer identifiers or
13122 peer names, or a struct of peer attributes, only peers matching
13123 the filter will be returned. If return_fields is specified, only the
13124 specified details will be returned.</P
13125 ></BLOCKQUOTE
13126 ></P
13127 ><P
13128 >Allowed Roles:<A
13129 NAME="AEN4306"
13130 ></A
13131 ><BLOCKQUOTE
13132 CLASS="BLOCKQUOTE"
13133 ><P
13134 >admin, node</P
13135 ></BLOCKQUOTE
13136 ></P
13137 ><P
13138 >Parameters:</P
13139 ><P
13140 ></P
13141 ><UL
13142 ><LI
13143 ><P
13144 >&#13;                          <CODE
13145 CLASS="parameter"
13146 >auth</CODE
13147 >
13148 : struct, API authentication structure                  </P
13149 ><P
13150 ></P
13151 ><UL
13152 ><LI
13153 ><P
13154 >&#13;                                          <CODE
13155 CLASS="parameter"
13156 >AuthMethod</CODE
13157 >
13158 : string, Authentication method to use                                  </P
13159 ></LI
13160 ></UL
13161 ></LI
13162 ><LI
13163 ><P
13164 >&#13;                          <CODE
13165 CLASS="parameter"
13166 >peer_filter</CODE
13167 >
13168 : array of int or string or struct                      </P
13169 ><P
13170 ></P
13171 ><UL
13172 ><LI
13173 ><P
13174 >&#13;array of int or string                                    </P
13175 ><P
13176 ></P
13177 ><UL
13178 ><LI
13179 ><P
13180 >&#13;int, Peer identifier                                                      </P
13181 ></LI
13182 ><LI
13183 ><P
13184 >&#13;string, Peer name                                                 </P
13185 ></LI
13186 ></UL
13187 ></LI
13188 ><LI
13189 ><P
13190 >&#13;struct, Attribute filter                                  </P
13191 ><P
13192 ></P
13193 ><UL
13194 ><LI
13195 ><P
13196 >&#13;                                                          <CODE
13197 CLASS="parameter"
13198 >key</CODE
13199 >
13200 : string or array of string                                                     </P
13201 ><P
13202 ></P
13203 ><UL
13204 ><LI
13205 ><P
13206 >&#13;string, Peer GPG public key                                                                       </P
13207 ></LI
13208 ><LI
13209 ><P
13210 >&#13;array of string, Peer GPG public key                                                                      </P
13211 ></LI
13212 ></UL
13213 ></LI
13214 ><LI
13215 ><P
13216 >&#13;                                                          <CODE
13217 CLASS="parameter"
13218 >cacert</CODE
13219 >
13220 : string or array of string                                                     </P
13221 ><P
13222 ></P
13223 ><UL
13224 ><LI
13225 ><P
13226 >&#13;string, Peer SSL public certificate                                                                       </P
13227 ></LI
13228 ><LI
13229 ><P
13230 >&#13;array of string, Peer SSL public certificate                                                                      </P
13231 ></LI
13232 ></UL
13233 ></LI
13234 ><LI
13235 ><P
13236 >&#13;                                                          <CODE
13237 CLASS="parameter"
13238 >peer_id</CODE
13239 >
13240 : int or array of int                                                   </P
13241 ><P
13242 ></P
13243 ><UL
13244 ><LI
13245 ><P
13246 >&#13;int, Peer identifier                                                                      </P
13247 ></LI
13248 ><LI
13249 ><P
13250 >&#13;array of int, Peer identifier                                                                     </P
13251 ></LI
13252 ></UL
13253 ></LI
13254 ><LI
13255 ><P
13256 >&#13;                                                          <CODE
13257 CLASS="parameter"
13258 >peername</CODE
13259 >
13260 : string or array of string                                                     </P
13261 ><P
13262 ></P
13263 ><UL
13264 ><LI
13265 ><P
13266 >&#13;string, Peer name                                                                 </P
13267 ></LI
13268 ><LI
13269 ><P
13270 >&#13;array of string, Peer name                                                                        </P
13271 ></LI
13272 ></UL
13273 ></LI
13274 ><LI
13275 ><P
13276 >&#13;                                                          <CODE
13277 CLASS="parameter"
13278 >peer_url</CODE
13279 >
13280 : string or array of string                                                     </P
13281 ><P
13282 ></P
13283 ><UL
13284 ><LI
13285 ><P
13286 >&#13;string, Peer API URL                                                                      </P
13287 ></LI
13288 ><LI
13289 ><P
13290 >&#13;array of string, Peer API URL                                                                     </P
13291 ></LI
13292 ></UL
13293 ></LI
13294 ></UL
13295 ></LI
13296 ></UL
13297 ></LI
13298 ><LI
13299 ><P
13300 >&#13;                          <CODE
13301 CLASS="parameter"
13302 >return_fields</CODE
13303 >
13304 : array, List of fields to return                       </P
13305 ><P
13306 ></P
13307 ><UL
13308 ><LI
13309 ><P
13310 >&#13;string                                    </P
13311 ></LI
13312 ></UL
13313 ></LI
13314 ></UL
13315 ><P
13316 >Returns:</P
13317 ><P
13318 ></P
13319 ><UL
13320 ><LI
13321 ><P
13322 >&#13;array of struct                   </P
13323 ><P
13324 ></P
13325 ><UL
13326 ><LI
13327 ><P
13328 >&#13;                                          <CODE
13329 CLASS="parameter"
13330 >node_ids</CODE
13331 >
13332 : array, List of nodes for which this peer is authoritative                                     </P
13333 ><P
13334 ></P
13335 ><UL
13336 ><LI
13337 ><P
13338 >&#13;int                                                       </P
13339 ></LI
13340 ></UL
13341 ></LI
13342 ><LI
13343 ><P
13344 >&#13;                                          <CODE
13345 CLASS="parameter"
13346 >key_ids</CODE
13347 >
13348 : array, List of keys for which this peer is authoritative                                      </P
13349 ><P
13350 ></P
13351 ><UL
13352 ><LI
13353 ><P
13354 >&#13;int                                                       </P
13355 ></LI
13356 ></UL
13357 ></LI
13358 ><LI
13359 ><P
13360 >&#13;                                          <CODE
13361 CLASS="parameter"
13362 >person_ids</CODE
13363 >
13364 : array, List of users for which this peer is authoritative                                     </P
13365 ><P
13366 ></P
13367 ><UL
13368 ><LI
13369 ><P
13370 >&#13;int                                                       </P
13371 ></LI
13372 ></UL
13373 ></LI
13374 ><LI
13375 ><P
13376 >&#13;                                          <CODE
13377 CLASS="parameter"
13378 >peername</CODE
13379 >
13380 : string, Peer name                                     </P
13381 ></LI
13382 ><LI
13383 ><P
13384 >&#13;                                          <CODE
13385 CLASS="parameter"
13386 >peer_url</CODE
13387 >
13388 : string, Peer API URL                                  </P
13389 ></LI
13390 ><LI
13391 ><P
13392 >&#13;                                          <CODE
13393 CLASS="parameter"
13394 >slice_ids</CODE
13395 >
13396 : array, List of slices for which this peer is authoritative                                    </P
13397 ><P
13398 ></P
13399 ><UL
13400 ><LI
13401 ><P
13402 >&#13;int                                                       </P
13403 ></LI
13404 ></UL
13405 ></LI
13406 ><LI
13407 ><P
13408 >&#13;                                          <CODE
13409 CLASS="parameter"
13410 >key</CODE
13411 >
13412 : string, Peer GPG public key                                   </P
13413 ></LI
13414 ><LI
13415 ><P
13416 >&#13;                                          <CODE
13417 CLASS="parameter"
13418 >cacert</CODE
13419 >
13420 : string, Peer SSL public certificate                                   </P
13421 ></LI
13422 ><LI
13423 ><P
13424 >&#13;                                          <CODE
13425 CLASS="parameter"
13426 >site_ids</CODE
13427 >
13428 : array, List of sites for which this peer is authoritative                                     </P
13429 ><P
13430 ></P
13431 ><UL
13432 ><LI
13433 ><P
13434 >&#13;int                                                       </P
13435 ></LI
13436 ></UL
13437 ></LI
13438 ><LI
13439 ><P
13440 >&#13;                                          <CODE
13441 CLASS="parameter"
13442 >peer_id</CODE
13443 >
13444 : int, Peer identifier                                  </P
13445 ></LI
13446 ></UL
13447 ></LI
13448 ></UL
13449 ></DIV
13450 ><DIV
13451 CLASS="section"
13452 ><HR><H2
13453 CLASS="section"
13454 ><A
13455 NAME="GetPersons"
13456 >2.84. GetPersons</A
13457 ></H2
13458 ><P
13459 >Prototype:<A
13460 NAME="AEN4430"
13461 ></A
13462 ><BLOCKQUOTE
13463 CLASS="BLOCKQUOTE"
13464 ><P
13465 >GetPersons (auth, person_filter, return_fields)</P
13466 ></BLOCKQUOTE
13467 ></P
13468 ><P
13469 >Description:<A
13470 NAME="AEN4433"
13471 ></A
13472 ><BLOCKQUOTE
13473 CLASS="BLOCKQUOTE"
13474 ><P
13475 >Returns an array of structs containing details about users. If
13476 person_filter is specified and is an array of user identifiers or
13477 usernames, or a struct of user attributes, only users matching the
13478 filter will be returned. If return_fields is specified, only the
13479 specified details will be returned.</P
13480 ><P
13481 >Users and techs may only retrieve details about themselves. PIs
13482 may retrieve details about themselves and others at their
13483 sites. Admins and nodes may retrieve details about all accounts.</P
13484 ></BLOCKQUOTE
13485 ></P
13486 ><P
13487 >Allowed Roles:<A
13488 NAME="AEN4437"
13489 ></A
13490 ><BLOCKQUOTE
13491 CLASS="BLOCKQUOTE"
13492 ><P
13493 >admin, pi, user, tech, node</P
13494 ></BLOCKQUOTE
13495 ></P
13496 ><P
13497 >Parameters:</P
13498 ><P
13499 ></P
13500 ><UL
13501 ><LI
13502 ><P
13503 >&#13;                          <CODE
13504 CLASS="parameter"
13505 >auth</CODE
13506 >
13507 : struct, API authentication structure                  </P
13508 ><P
13509 ></P
13510 ><UL
13511 ><LI
13512 ><P
13513 >&#13;                                          <CODE
13514 CLASS="parameter"
13515 >AuthMethod</CODE
13516 >
13517 : string, Authentication method to use                                  </P
13518 ></LI
13519 ></UL
13520 ></LI
13521 ><LI
13522 ><P
13523 >&#13;                          <CODE
13524 CLASS="parameter"
13525 >person_filter</CODE
13526 >
13527 : array of int or string or struct                      </P
13528 ><P
13529 ></P
13530 ><UL
13531 ><LI
13532 ><P
13533 >&#13;array of int or string                                    </P
13534 ><P
13535 ></P
13536 ><UL
13537 ><LI
13538 ><P
13539 >&#13;int, User identifier                                                      </P
13540 ></LI
13541 ><LI
13542 ><P
13543 >&#13;string, Primary e-mail address                                                    </P
13544 ></LI
13545 ></UL
13546 ></LI
13547 ><LI
13548 ><P
13549 >&#13;struct, Attribute filter                                  </P
13550 ><P
13551 ></P
13552 ><UL
13553 ><LI
13554 ><P
13555 >&#13;                                                          <CODE
13556 CLASS="parameter"
13557 >bio</CODE
13558 >
13559 : string or array of string                                                     </P
13560 ><P
13561 ></P
13562 ><UL
13563 ><LI
13564 ><P
13565 >&#13;string, Biography                                                                 </P
13566 ></LI
13567 ><LI
13568 ><P
13569 >&#13;array of string, Biography                                                                        </P
13570 ></LI
13571 ></UL
13572 ></LI
13573 ><LI
13574 ><P
13575 >&#13;                                                          <CODE
13576 CLASS="parameter"
13577 >first_name</CODE
13578 >
13579 : string or array of string                                                     </P
13580 ><P
13581 ></P
13582 ><UL
13583 ><LI
13584 ><P
13585 >&#13;string, Given name                                                                        </P
13586 ></LI
13587 ><LI
13588 ><P
13589 >&#13;array of string, Given name                                                                       </P
13590 ></LI
13591 ></UL
13592 ></LI
13593 ><LI
13594 ><P
13595 >&#13;                                                          <CODE
13596 CLASS="parameter"
13597 >last_name</CODE
13598 >
13599 : string or array of string                                                     </P
13600 ><P
13601 ></P
13602 ><UL
13603 ><LI
13604 ><P
13605 >&#13;string, Surname                                                                   </P
13606 ></LI
13607 ><LI
13608 ><P
13609 >&#13;array of string, Surname                                                                  </P
13610 ></LI
13611 ></UL
13612 ></LI
13613 ><LI
13614 ><P
13615 >&#13;                                                          <CODE
13616 CLASS="parameter"
13617 >last_updated</CODE
13618 >
13619 : int or array of int                                                   </P
13620 ><P
13621 ></P
13622 ><UL
13623 ><LI
13624 ><P
13625 >&#13;int, Date and time of last update                                                                 </P
13626 ></LI
13627 ><LI
13628 ><P
13629 >&#13;array of int, Date and time of last update                                                                        </P
13630 ></LI
13631 ></UL
13632 ></LI
13633 ><LI
13634 ><P
13635 >&#13;                                                          <CODE
13636 CLASS="parameter"
13637 >title</CODE
13638 >
13639 : string or array of string                                                     </P
13640 ><P
13641 ></P
13642 ><UL
13643 ><LI
13644 ><P
13645 >&#13;string, Title                                                                     </P
13646 ></LI
13647 ><LI
13648 ><P
13649 >&#13;array of string, Title                                                                    </P
13650 ></LI
13651 ></UL
13652 ></LI
13653 ><LI
13654 ><P
13655 >&#13;                                                          <CODE
13656 CLASS="parameter"
13657 >url</CODE
13658 >
13659 : string or array of string                                                     </P
13660 ><P
13661 ></P
13662 ><UL
13663 ><LI
13664 ><P
13665 >&#13;string, Home page                                                                 </P
13666 ></LI
13667 ><LI
13668 ><P
13669 >&#13;array of string, Home page                                                                        </P
13670 ></LI
13671 ></UL
13672 ></LI
13673 ><LI
13674 ><P
13675 >&#13;                                                          <CODE
13676 CLASS="parameter"
13677 >verification_key</CODE
13678 >
13679 : string or array of string                                                     </P
13680 ><P
13681 ></P
13682 ><UL
13683 ><LI
13684 ><P
13685 >&#13;string, Reset password key                                                                        </P
13686 ></LI
13687 ><LI
13688 ><P
13689 >&#13;array of string, Reset password key                                                                       </P
13690 ></LI
13691 ></UL
13692 ></LI
13693 ><LI
13694 ><P
13695 >&#13;                                                          <CODE
13696 CLASS="parameter"
13697 >enabled</CODE
13698 >
13699 : boolean or array of boolean                                                   </P
13700 ><P
13701 ></P
13702 ><UL
13703 ><LI
13704 ><P
13705 >&#13;boolean, Has been enabled                                                                 </P
13706 ></LI
13707 ><LI
13708 ><P
13709 >&#13;array of boolean, Has been enabled                                                                        </P
13710 ></LI
13711 ></UL
13712 ></LI
13713 ><LI
13714 ><P
13715 >&#13;                                                          <CODE
13716 CLASS="parameter"
13717 >phone</CODE
13718 >
13719 : string or array of string                                                     </P
13720 ><P
13721 ></P
13722 ><UL
13723 ><LI
13724 ><P
13725 >&#13;string, Telephone number                                                                  </P
13726 ></LI
13727 ><LI
13728 ><P
13729 >&#13;array of string, Telephone number                                                                 </P
13730 ></LI
13731 ></UL
13732 ></LI
13733 ><LI
13734 ><P
13735 >&#13;                                                          <CODE
13736 CLASS="parameter"
13737 >peer_person_id</CODE
13738 >
13739 : int or array of int                                                   </P
13740 ><P
13741 ></P
13742 ><UL
13743 ><LI
13744 ><P
13745 >&#13;int, Foreign user identifier at peer                                                                      </P
13746 ></LI
13747 ><LI
13748 ><P
13749 >&#13;array of int, Foreign user identifier at peer                                                                     </P
13750 ></LI
13751 ></UL
13752 ></LI
13753 ><LI
13754 ><P
13755 >&#13;                                                          <CODE
13756 CLASS="parameter"
13757 >password</CODE
13758 >
13759 : string or array of string                                                     </P
13760 ><P
13761 ></P
13762 ><UL
13763 ><LI
13764 ><P
13765 >&#13;string, Account password in crypt() form                                                                  </P
13766 ></LI
13767 ><LI
13768 ><P
13769 >&#13;array of string, Account password in crypt() form                                                                 </P
13770 ></LI
13771 ></UL
13772 ></LI
13773 ><LI
13774 ><P
13775 >&#13;                                                          <CODE
13776 CLASS="parameter"
13777 >person_id</CODE
13778 >
13779 : int or array of int                                                   </P
13780 ><P
13781 ></P
13782 ><UL
13783 ><LI
13784 ><P
13785 >&#13;int, User identifier                                                                      </P
13786 ></LI
13787 ><LI
13788 ><P
13789 >&#13;array of int, User identifier                                                                     </P
13790 ></LI
13791 ></UL
13792 ></LI
13793 ><LI
13794 ><P
13795 >&#13;                                                          <CODE
13796 CLASS="parameter"
13797 >date_created</CODE
13798 >
13799 : int or array of int                                                   </P
13800 ><P
13801 ></P
13802 ><UL
13803 ><LI
13804 ><P
13805 >&#13;int, Date and time when account was created                                                                       </P
13806 ></LI
13807 ><LI
13808 ><P
13809 >&#13;array of int, Date and time when account was created                                                                      </P
13810 ></LI
13811 ></UL
13812 ></LI
13813 ><LI
13814 ><P
13815 >&#13;                                                          <CODE
13816 CLASS="parameter"
13817 >peer_id</CODE
13818 >
13819 : int or array of int                                                   </P
13820 ><P
13821 ></P
13822 ><UL
13823 ><LI
13824 ><P
13825 >&#13;int, Peer to which this user belongs                                                                      </P
13826 ></LI
13827 ><LI
13828 ><P
13829 >&#13;array of int, Peer to which this user belongs                                                                     </P
13830 ></LI
13831 ></UL
13832 ></LI
13833 ><LI
13834 ><P
13835 >&#13;                                                          <CODE
13836 CLASS="parameter"
13837 >verification_expires</CODE
13838 >
13839 : int or array of int                                                   </P
13840 ><P
13841 ></P
13842 ><UL
13843 ><LI
13844 ><P
13845 >&#13;int, Date and time when verification_key expires                                                                  </P
13846 ></LI
13847 ><LI
13848 ><P
13849 >&#13;array of int, Date and time when verification_key expires                                                                 </P
13850 ></LI
13851 ></UL
13852 ></LI
13853 ><LI
13854 ><P
13855 >&#13;                                                          <CODE
13856 CLASS="parameter"
13857 >email</CODE
13858 >
13859 : string or array of string                                                     </P
13860 ><P
13861 ></P
13862 ><UL
13863 ><LI
13864 ><P
13865 >&#13;string, Primary e-mail address                                                                    </P
13866 ></LI
13867 ><LI
13868 ><P
13869 >&#13;array of string, Primary e-mail address                                                                   </P
13870 ></LI
13871 ></UL
13872 ></LI
13873 ></UL
13874 ></LI
13875 ></UL
13876 ></LI
13877 ><LI
13878 ><P
13879 >&#13;                          <CODE
13880 CLASS="parameter"
13881 >return_fields</CODE
13882 >
13883 : array, List of fields to return                       </P
13884 ><P
13885 ></P
13886 ><UL
13887 ><LI
13888 ><P
13889 >&#13;string                                    </P
13890 ></LI
13891 ></UL
13892 ></LI
13893 ></UL
13894 ><P
13895 >Returns:</P
13896 ><P
13897 ></P
13898 ><UL
13899 ><LI
13900 ><P
13901 >&#13;array of struct                   </P
13902 ><P
13903 ></P
13904 ><UL
13905 ><LI
13906 ><P
13907 >&#13;                                          <CODE
13908 CLASS="parameter"
13909 >bio</CODE
13910 >
13911 : string, Biography                                     </P
13912 ></LI
13913 ><LI
13914 ><P
13915 >&#13;                                          <CODE
13916 CLASS="parameter"
13917 >first_name</CODE
13918 >
13919 : string, Given name                                    </P
13920 ></LI
13921 ><LI
13922 ><P
13923 >&#13;                                          <CODE
13924 CLASS="parameter"
13925 >last_name</CODE
13926 >
13927 : string, Surname                                       </P
13928 ></LI
13929 ><LI
13930 ><P
13931 >&#13;                                          <CODE
13932 CLASS="parameter"
13933 >last_updated</CODE
13934 >
13935 : int, Date and time of last update                                     </P
13936 ></LI
13937 ><LI
13938 ><P
13939 >&#13;                                          <CODE
13940 CLASS="parameter"
13941 >roles</CODE
13942 >
13943 : array, List of roles                                  </P
13944 ><P
13945 ></P
13946 ><UL
13947 ><LI
13948 ><P
13949 >&#13;string                                                    </P
13950 ></LI
13951 ></UL
13952 ></LI
13953 ><LI
13954 ><P
13955 >&#13;                                          <CODE
13956 CLASS="parameter"
13957 >title</CODE
13958 >
13959 : string, Title                                 </P
13960 ></LI
13961 ><LI
13962 ><P
13963 >&#13;                                          <CODE
13964 CLASS="parameter"
13965 >url</CODE
13966 >
13967 : string, Home page                                     </P
13968 ></LI
13969 ><LI
13970 ><P
13971 >&#13;                                          <CODE
13972 CLASS="parameter"
13973 >key_ids</CODE
13974 >
13975 : array, List of key identifiers                                        </P
13976 ><P
13977 ></P
13978 ><UL
13979 ><LI
13980 ><P
13981 >&#13;int                                                       </P
13982 ></LI
13983 ></UL
13984 ></LI
13985 ><LI
13986 ><P
13987 >&#13;                                          <CODE
13988 CLASS="parameter"
13989 >enabled</CODE
13990 >
13991 : boolean, Has been enabled                                     </P
13992 ></LI
13993 ><LI
13994 ><P
13995 >&#13;                                          <CODE
13996 CLASS="parameter"
13997 >slice_ids</CODE
13998 >
13999 : array, List of slice identifiers                                      </P
14000 ><P
14001 ></P
14002 ><UL
14003 ><LI
14004 ><P
14005 >&#13;int                                                       </P
14006 ></LI
14007 ></UL
14008 ></LI
14009 ><LI
14010 ><P
14011 >&#13;                                          <CODE
14012 CLASS="parameter"
14013 >phone</CODE
14014 >
14015 : string, Telephone number                                      </P
14016 ></LI
14017 ><LI
14018 ><P
14019 >&#13;                                          <CODE
14020 CLASS="parameter"
14021 >peer_person_id</CODE
14022 >
14023 : int, Foreign user identifier at peer                                  </P
14024 ></LI
14025 ><LI
14026 ><P
14027 >&#13;                                          <CODE
14028 CLASS="parameter"
14029 >role_ids</CODE
14030 >
14031 : array, List of role identifiers                                       </P
14032 ><P
14033 ></P
14034 ><UL
14035 ><LI
14036 ><P
14037 >&#13;int                                                       </P
14038 ></LI
14039 ></UL
14040 ></LI
14041 ><LI
14042 ><P
14043 >&#13;                                          <CODE
14044 CLASS="parameter"
14045 >person_id</CODE
14046 >
14047 : int, User identifier                                  </P
14048 ></LI
14049 ><LI
14050 ><P
14051 >&#13;                                          <CODE
14052 CLASS="parameter"
14053 >date_created</CODE
14054 >
14055 : int, Date and time when account was created                                   </P
14056 ></LI
14057 ><LI
14058 ><P
14059 >&#13;                                          <CODE
14060 CLASS="parameter"
14061 >site_ids</CODE
14062 >
14063 : array, List of site identifiers                                       </P
14064 ><P
14065 ></P
14066 ><UL
14067 ><LI
14068 ><P
14069 >&#13;int                                                       </P
14070 ></LI
14071 ></UL
14072 ></LI
14073 ><LI
14074 ><P
14075 >&#13;                                          <CODE
14076 CLASS="parameter"
14077 >peer_id</CODE
14078 >
14079 : int, Peer to which this user belongs                                  </P
14080 ></LI
14081 ><LI
14082 ><P
14083 >&#13;                                          <CODE
14084 CLASS="parameter"
14085 >email</CODE
14086 >
14087 : string, Primary e-mail address                                        </P
14088 ></LI
14089 ></UL
14090 ></LI
14091 ></UL
14092 ></DIV
14093 ><DIV
14094 CLASS="section"
14095 ><HR><H2
14096 CLASS="section"
14097 ><A
14098 NAME="GetRoles"
14099 >2.85. GetRoles</A
14100 ></H2
14101 ><P
14102 >Prototype:<A
14103 NAME="AEN4673"
14104 ></A
14105 ><BLOCKQUOTE
14106 CLASS="BLOCKQUOTE"
14107 ><P
14108 >GetRoles (auth)</P
14109 ></BLOCKQUOTE
14110 ></P
14111 ><P
14112 >Description:<A
14113 NAME="AEN4676"
14114 ></A
14115 ><BLOCKQUOTE
14116 CLASS="BLOCKQUOTE"
14117 ><P
14118 >Get an array of structs containing details about all roles.</P
14119 ></BLOCKQUOTE
14120 ></P
14121 ><P
14122 >Allowed Roles:<A
14123 NAME="AEN4679"
14124 ></A
14125 ><BLOCKQUOTE
14126 CLASS="BLOCKQUOTE"
14127 ><P
14128 >admin, pi, user, tech, node</P
14129 ></BLOCKQUOTE
14130 ></P
14131 ><P
14132 >Parameters:</P
14133 ><P
14134 ></P
14135 ><UL
14136 ><LI
14137 ><P
14138 >&#13;                          <CODE
14139 CLASS="parameter"
14140 >auth</CODE
14141 >
14142 : struct, API authentication structure                  </P
14143 ><P
14144 ></P
14145 ><UL
14146 ><LI
14147 ><P
14148 >&#13;                                          <CODE
14149 CLASS="parameter"
14150 >AuthMethod</CODE
14151 >
14152 : string, Authentication method to use                                  </P
14153 ></LI
14154 ></UL
14155 ></LI
14156 ></UL
14157 ><P
14158 >Returns:</P
14159 ><P
14160 ></P
14161 ><UL
14162 ><LI
14163 ><P
14164 >&#13;array of struct                   </P
14165 ><P
14166 ></P
14167 ><UL
14168 ><LI
14169 ><P
14170 >&#13;                                          <CODE
14171 CLASS="parameter"
14172 >name</CODE
14173 >
14174 : string, Role                                  </P
14175 ></LI
14176 ><LI
14177 ><P
14178 >&#13;                                          <CODE
14179 CLASS="parameter"
14180 >role_id</CODE
14181 >
14182 : int, Role identifier                                  </P
14183 ></LI
14184 ></UL
14185 ></LI
14186 ></UL
14187 ></DIV
14188 ><DIV
14189 CLASS="section"
14190 ><HR><H2
14191 CLASS="section"
14192 ><A
14193 NAME="GetSession"
14194 >2.86. GetSession</A
14195 ></H2
14196 ><P
14197 >Prototype:<A
14198 NAME="AEN4704"
14199 ></A
14200 ><BLOCKQUOTE
14201 CLASS="BLOCKQUOTE"
14202 ><P
14203 >GetSession (auth)</P
14204 ></BLOCKQUOTE
14205 ></P
14206 ><P
14207 >Description:<A
14208 NAME="AEN4707"
14209 ></A
14210 ><BLOCKQUOTE
14211 CLASS="BLOCKQUOTE"
14212 ><P
14213 >Returns a new session key if a user or node authenticated
14214 successfully, faults otherwise.</P
14215 ></BLOCKQUOTE
14216 ></P
14217 ><P
14218 >Allowed Roles:<A
14219 NAME="AEN4710"
14220 ></A
14221 ><BLOCKQUOTE
14222 CLASS="BLOCKQUOTE"
14223 ><P
14224 >admin, pi, user, tech, node</P
14225 ></BLOCKQUOTE
14226 ></P
14227 ><P
14228 >Parameters:</P
14229 ><P
14230 ></P
14231 ><UL
14232 ><LI
14233 ><P
14234 >&#13;                          <CODE
14235 CLASS="parameter"
14236 >auth</CODE
14237 >
14238 : struct, API authentication structure                  </P
14239 ><P
14240 ></P
14241 ><UL
14242 ><LI
14243 ><P
14244 >&#13;                                          <CODE
14245 CLASS="parameter"
14246 >AuthMethod</CODE
14247 >
14248 : string, Authentication method to use                                  </P
14249 ></LI
14250 ></UL
14251 ></LI
14252 ></UL
14253 ><P
14254 >Returns:</P
14255 ><P
14256 ></P
14257 ><UL
14258 ><LI
14259 ><P
14260 >&#13;string, Session key                       </P
14261 ></LI
14262 ></UL
14263 ></DIV
14264 ><DIV
14265 CLASS="section"
14266 ><HR><H2
14267 CLASS="section"
14268 ><A
14269 NAME="GetSites"
14270 >2.87. GetSites</A
14271 ></H2
14272 ><P
14273 >Prototype:<A
14274 NAME="AEN4728"
14275 ></A
14276 ><BLOCKQUOTE
14277 CLASS="BLOCKQUOTE"
14278 ><P
14279 >GetSites (auth, site_filter, return_fields)</P
14280 ></BLOCKQUOTE
14281 ></P
14282 ><P
14283 >Description:<A
14284 NAME="AEN4731"
14285 ></A
14286 ><BLOCKQUOTE
14287 CLASS="BLOCKQUOTE"
14288 ><P
14289 >Returns an array of structs containing details about sites. If
14290 site_filter is specified and is an array of site identifiers or
14291 hostnames, or a struct of site attributes, only sites matching the
14292 filter will be returned. If return_fields is specified, only the
14293 specified details will be returned.</P
14294 ></BLOCKQUOTE
14295 ></P
14296 ><P
14297 >Allowed Roles:<A
14298 NAME="AEN4734"
14299 ></A
14300 ><BLOCKQUOTE
14301 CLASS="BLOCKQUOTE"
14302 ><P
14303 >admin, pi, user, tech, node, anonymous</P
14304 ></BLOCKQUOTE
14305 ></P
14306 ><P
14307 >Parameters:</P
14308 ><P
14309 ></P
14310 ><UL
14311 ><LI
14312 ><P
14313 >&#13;                          <CODE
14314 CLASS="parameter"
14315 >auth</CODE
14316 >
14317 : struct, API authentication structure                  </P
14318 ><P
14319 ></P
14320 ><UL
14321 ><LI
14322 ><P
14323 >&#13;                                          <CODE
14324 CLASS="parameter"
14325 >AuthMethod</CODE
14326 >
14327 : string, Authentication method to use                                  </P
14328 ></LI
14329 ></UL
14330 ></LI
14331 ><LI
14332 ><P
14333 >&#13;                          <CODE
14334 CLASS="parameter"
14335 >site_filter</CODE
14336 >
14337 : array of int or string or struct                      </P
14338 ><P
14339 ></P
14340 ><UL
14341 ><LI
14342 ><P
14343 >&#13;array of int or string                                    </P
14344 ><P
14345 ></P
14346 ><UL
14347 ><LI
14348 ><P
14349 >&#13;int, Site identifier                                                      </P
14350 ></LI
14351 ><LI
14352 ><P
14353 >&#13;string, Site slice prefix                                                 </P
14354 ></LI
14355 ></UL
14356 ></LI
14357 ><LI
14358 ><P
14359 >&#13;struct, Attribute filter                                  </P
14360 ><P
14361 ></P
14362 ><UL
14363 ><LI
14364 ><P
14365 >&#13;                                                          <CODE
14366 CLASS="parameter"
14367 >last_updated</CODE
14368 >
14369 : int or array of int                                                   </P
14370 ><P
14371 ></P
14372 ><UL
14373 ><LI
14374 ><P
14375 >&#13;int, Date and time when site entry was last updated, in seconds since UNIX epoch                                                                  </P
14376 ></LI
14377 ><LI
14378 ><P
14379 >&#13;array of int, Date and time when site entry was last updated, in seconds since UNIX epoch                                                                 </P
14380 ></LI
14381 ></UL
14382 ></LI
14383 ><LI
14384 ><P
14385 >&#13;                                                          <CODE
14386 CLASS="parameter"
14387 >name</CODE
14388 >
14389 : string or array of string                                                     </P
14390 ><P
14391 ></P
14392 ><UL
14393 ><LI
14394 ><P
14395 >&#13;string, Full site name                                                                    </P
14396 ></LI
14397 ><LI
14398 ><P
14399 >&#13;array of string, Full site name                                                                   </P
14400 ></LI
14401 ></UL
14402 ></LI
14403 ><LI
14404 ><P
14405 >&#13;                                                          <CODE
14406 CLASS="parameter"
14407 >url</CODE
14408 >
14409 : string or array of string                                                     </P
14410 ><P
14411 ></P
14412 ><UL
14413 ><LI
14414 ><P
14415 >&#13;string, URL of a page that describes the site                                                                     </P
14416 ></LI
14417 ><LI
14418 ><P
14419 >&#13;array of string, URL of a page that describes the site                                                                    </P
14420 ></LI
14421 ></UL
14422 ></LI
14423 ><LI
14424 ><P
14425 >&#13;                                                          <CODE
14426 CLASS="parameter"
14427 >site_id</CODE
14428 >
14429 : int or array of int                                                   </P
14430 ><P
14431 ></P
14432 ><UL
14433 ><LI
14434 ><P
14435 >&#13;int, Site identifier                                                                      </P
14436 ></LI
14437 ><LI
14438 ><P
14439 >&#13;array of int, Site identifier                                                                     </P
14440 ></LI
14441 ></UL
14442 ></LI
14443 ><LI
14444 ><P
14445 >&#13;                                                          <CODE
14446 CLASS="parameter"
14447 >enabled</CODE
14448 >
14449 : boolean or array of boolean                                                   </P
14450 ><P
14451 ></P
14452 ><UL
14453 ><LI
14454 ><P
14455 >&#13;boolean, Has been enabled                                                                 </P
14456 ></LI
14457 ><LI
14458 ><P
14459 >&#13;array of boolean, Has been enabled                                                                        </P
14460 ></LI
14461 ></UL
14462 ></LI
14463 ><LI
14464 ><P
14465 >&#13;                                                          <CODE
14466 CLASS="parameter"
14467 >longitude</CODE
14468 >
14469 : double or array of double                                                     </P
14470 ><P
14471 ></P
14472 ><UL
14473 ><LI
14474 ><P
14475 >&#13;double, Decimal longitude of the site                                                                     </P
14476 ></LI
14477 ><LI
14478 ><P
14479 >&#13;array of double, Decimal longitude of the site                                                                    </P
14480 ></LI
14481 ></UL
14482 ></LI
14483 ><LI
14484 ><P
14485 >&#13;                                                          <CODE
14486 CLASS="parameter"
14487 >latitude</CODE
14488 >
14489 : double or array of double                                                     </P
14490 ><P
14491 ></P
14492 ><UL
14493 ><LI
14494 ><P
14495 >&#13;double, Decimal latitude of the site                                                                      </P
14496 ></LI
14497 ><LI
14498 ><P
14499 >&#13;array of double, Decimal latitude of the site                                                                     </P
14500 ></LI
14501 ></UL
14502 ></LI
14503 ><LI
14504 ><P
14505 >&#13;                                                          <CODE
14506 CLASS="parameter"
14507 >max_slices</CODE
14508 >
14509 : int or array of int                                                   </P
14510 ><P
14511 ></P
14512 ><UL
14513 ><LI
14514 ><P
14515 >&#13;int, Maximum number of slices that the site is able to create                                                                     </P
14516 ></LI
14517 ><LI
14518 ><P
14519 >&#13;array of int, Maximum number of slices that the site is able to create                                                                    </P
14520 ></LI
14521 ></UL
14522 ></LI
14523 ><LI
14524 ><P
14525 >&#13;                                                          <CODE
14526 CLASS="parameter"
14527 >login_base</CODE
14528 >
14529 : string or array of string                                                     </P
14530 ><P
14531 ></P
14532 ><UL
14533 ><LI
14534 ><P
14535 >&#13;string, Site slice prefix                                                                 </P
14536 ></LI
14537 ><LI
14538 ><P
14539 >&#13;array of string, Site slice prefix                                                                        </P
14540 ></LI
14541 ></UL
14542 ></LI
14543 ><LI
14544 ><P
14545 >&#13;                                                          <CODE
14546 CLASS="parameter"
14547 >is_public</CODE
14548 >
14549 : boolean or array of boolean                                                   </P
14550 ><P
14551 ></P
14552 ><UL
14553 ><LI
14554 ><P
14555 >&#13;boolean, Publicly viewable site                                                                   </P
14556 ></LI
14557 ><LI
14558 ><P
14559 >&#13;array of boolean, Publicly viewable site                                                                  </P
14560 ></LI
14561 ></UL
14562 ></LI
14563 ><LI
14564 ><P
14565 >&#13;                                                          <CODE
14566 CLASS="parameter"
14567 >max_slivers</CODE
14568 >
14569 : int or array of int                                                   </P
14570 ><P
14571 ></P
14572 ><UL
14573 ><LI
14574 ><P
14575 >&#13;int, Maximum number of slivers that the site is able to create                                                                    </P
14576 ></LI
14577 ><LI
14578 ><P
14579 >&#13;array of int, Maximum number of slivers that the site is able to create                                                                   </P
14580 ></LI
14581 ></UL
14582 ></LI
14583 ><LI
14584 ><P
14585 >&#13;                                                          <CODE
14586 CLASS="parameter"
14587 >date_created</CODE
14588 >
14589 : int or array of int                                                   </P
14590 ><P
14591 ></P
14592 ><UL
14593 ><LI
14594 ><P
14595 >&#13;int, Date and time when site entry was created, in seconds since UNIX epoch                                                                       </P
14596 ></LI
14597 ><LI
14598 ><P
14599 >&#13;array of int, Date and time when site entry was created, in seconds since UNIX epoch                                                                      </P
14600 ></LI
14601 ></UL
14602 ></LI
14603 ><LI
14604 ><P
14605 >&#13;                                                          <CODE
14606 CLASS="parameter"
14607 >peer_site_id</CODE
14608 >
14609 : int or array of int                                                   </P
14610 ><P
14611 ></P
14612 ><UL
14613 ><LI
14614 ><P
14615 >&#13;int, Foreign site identifier at peer                                                                      </P
14616 ></LI
14617 ><LI
14618 ><P
14619 >&#13;array of int, Foreign site identifier at peer                                                                     </P
14620 ></LI
14621 ></UL
14622 ></LI
14623 ><LI
14624 ><P
14625 >&#13;                                                          <CODE
14626 CLASS="parameter"
14627 >peer_id</CODE
14628 >
14629 : int or array of int                                                   </P
14630 ><P
14631 ></P
14632 ><UL
14633 ><LI
14634 ><P
14635 >&#13;int, Peer to which this site belongs                                                                      </P
14636 ></LI
14637 ><LI
14638 ><P
14639 >&#13;array of int, Peer to which this site belongs                                                                     </P
14640 ></LI
14641 ></UL
14642 ></LI
14643 ><LI
14644 ><P
14645 >&#13;                                                          <CODE
14646 CLASS="parameter"
14647 >abbreviated_name</CODE
14648 >
14649 : string or array of string                                                     </P
14650 ><P
14651 ></P
14652 ><UL
14653 ><LI
14654 ><P
14655 >&#13;string, Abbreviated site name                                                                     </P
14656 ></LI
14657 ><LI
14658 ><P
14659 >&#13;array of string, Abbreviated site name                                                                    </P
14660 ></LI
14661 ></UL
14662 ></LI
14663 ></UL
14664 ></LI
14665 ></UL
14666 ></LI
14667 ><LI
14668 ><P
14669 >&#13;                          <CODE
14670 CLASS="parameter"
14671 >return_fields</CODE
14672 >
14673 : array, List of fields to return                       </P
14674 ><P
14675 ></P
14676 ><UL
14677 ><LI
14678 ><P
14679 >&#13;string                                    </P
14680 ></LI
14681 ></UL
14682 ></LI
14683 ></UL
14684 ><P
14685 >Returns:</P
14686 ><P
14687 ></P
14688 ><UL
14689 ><LI
14690 ><P
14691 >&#13;array of struct                   </P
14692 ><P
14693 ></P
14694 ><UL
14695 ><LI
14696 ><P
14697 >&#13;                                          <CODE
14698 CLASS="parameter"
14699 >address_ids</CODE
14700 >
14701 : array, List of address identifiers                                    </P
14702 ><P
14703 ></P
14704 ><UL
14705 ><LI
14706 ><P
14707 >&#13;int                                                       </P
14708 ></LI
14709 ></UL
14710 ></LI
14711 ><LI
14712 ><P
14713 >&#13;                                          <CODE
14714 CLASS="parameter"
14715 >pcu_ids</CODE
14716 >
14717 : array, List of PCU identifiers                                        </P
14718 ><P
14719 ></P
14720 ><UL
14721 ><LI
14722 ><P
14723 >&#13;int                                                       </P
14724 ></LI
14725 ></UL
14726 ></LI
14727 ><LI
14728 ><P
14729 >&#13;                                          <CODE
14730 CLASS="parameter"
14731 >last_updated</CODE
14732 >
14733 : int, Date and time when site entry was last updated, in seconds since UNIX epoch                                      </P
14734 ></LI
14735 ><LI
14736 ><P
14737 >&#13;                                          <CODE
14738 CLASS="parameter"
14739 >name</CODE
14740 >
14741 : string, Full site name                                        </P
14742 ></LI
14743 ><LI
14744 ><P
14745 >&#13;                                          <CODE
14746 CLASS="parameter"
14747 >node_ids</CODE
14748 >
14749 : array, List of site node identifiers                                  </P
14750 ><P
14751 ></P
14752 ><UL
14753 ><LI
14754 ><P
14755 >&#13;int                                                       </P
14756 ></LI
14757 ></UL
14758 ></LI
14759 ><LI
14760 ><P
14761 >&#13;                                          <CODE
14762 CLASS="parameter"
14763 >url</CODE
14764 >
14765 : string, URL of a page that describes the site                                 </P
14766 ></LI
14767 ><LI
14768 ><P
14769 >&#13;                                          <CODE
14770 CLASS="parameter"
14771 >enabled</CODE
14772 >
14773 : boolean, Has been enabled                                     </P
14774 ></LI
14775 ><LI
14776 ><P
14777 >&#13;                                          <CODE
14778 CLASS="parameter"
14779 >person_ids</CODE
14780 >
14781 : array, List of account identifiers                                    </P
14782 ><P
14783 ></P
14784 ><UL
14785 ><LI
14786 ><P
14787 >&#13;int                                                       </P
14788 ></LI
14789 ></UL
14790 ></LI
14791 ><LI
14792 ><P
14793 >&#13;                                          <CODE
14794 CLASS="parameter"
14795 >site_id</CODE
14796 >
14797 : int, Site identifier                                  </P
14798 ></LI
14799 ><LI
14800 ><P
14801 >&#13;                                          <CODE
14802 CLASS="parameter"
14803 >longitude</CODE
14804 >
14805 : double, Decimal longitude of the site                                 </P
14806 ></LI
14807 ><LI
14808 ><P
14809 >&#13;                                          <CODE
14810 CLASS="parameter"
14811 >slice_ids</CODE
14812 >
14813 : array, List of slice identifiers                                      </P
14814 ><P
14815 ></P
14816 ><UL
14817 ><LI
14818 ><P
14819 >&#13;int                                                       </P
14820 ></LI
14821 ></UL
14822 ></LI
14823 ><LI
14824 ><P
14825 >&#13;                                          <CODE
14826 CLASS="parameter"
14827 >max_slivers</CODE
14828 >
14829 : int, Maximum number of slivers that the site is able to create                                        </P
14830 ></LI
14831 ><LI
14832 ><P
14833 >&#13;                                          <CODE
14834 CLASS="parameter"
14835 >max_slices</CODE
14836 >
14837 : int, Maximum number of slices that the site is able to create                                 </P
14838 ></LI
14839 ><LI
14840 ><P
14841 >&#13;                                          <CODE
14842 CLASS="parameter"
14843 >login_base</CODE
14844 >
14845 : string, Site slice prefix                                     </P
14846 ></LI
14847 ><LI
14848 ><P
14849 >&#13;                                          <CODE
14850 CLASS="parameter"
14851 >date_created</CODE
14852 >
14853 : int, Date and time when site entry was created, in seconds since UNIX epoch                                   </P
14854 ></LI
14855 ><LI
14856 ><P
14857 >&#13;                                          <CODE
14858 CLASS="parameter"
14859 >latitude</CODE
14860 >
14861 : double, Decimal latitude of the site                                  </P
14862 ></LI
14863 ><LI
14864 ><P
14865 >&#13;                                          <CODE
14866 CLASS="parameter"
14867 >is_public</CODE
14868 >
14869 : boolean, Publicly viewable site                                       </P
14870 ></LI
14871 ><LI
14872 ><P
14873 >&#13;                                          <CODE
14874 CLASS="parameter"
14875 >peer_site_id</CODE
14876 >
14877 : int, Foreign site identifier at peer                                  </P
14878 ></LI
14879 ><LI
14880 ><P
14881 >&#13;                                          <CODE
14882 CLASS="parameter"
14883 >peer_id</CODE
14884 >
14885 : int, Peer to which this site belongs                                  </P
14886 ></LI
14887 ><LI
14888 ><P
14889 >&#13;                                          <CODE
14890 CLASS="parameter"
14891 >abbreviated_name</CODE
14892 >
14893 : string, Abbreviated site name                                 </P
14894 ></LI
14895 ></UL
14896 ></LI
14897 ></UL
14898 ></DIV
14899 ><DIV
14900 CLASS="section"
14901 ><HR><H2
14902 CLASS="section"
14903 ><A
14904 NAME="GetSliceAttributes"
14905 >2.88. GetSliceAttributes</A
14906 ></H2
14907 ><P
14908 >Prototype:<A
14909 NAME="AEN4968"
14910 ></A
14911 ><BLOCKQUOTE
14912 CLASS="BLOCKQUOTE"
14913 ><P
14914 >GetSliceAttributes (auth, slice_attribute_filter, return_fields)</P
14915 ></BLOCKQUOTE
14916 ></P
14917 ><P
14918 >Description:<A
14919 NAME="AEN4971"
14920 ></A
14921 ><BLOCKQUOTE
14922 CLASS="BLOCKQUOTE"
14923 ><P
14924 >Returns an array of structs containing details about slice and
14925 sliver attributes. An attribute is a sliver attribute if the
14926 node_id field is set. If slice_attribute_filter is specified and
14927 is an array of slice attribute identifiers, or a struct of slice
14928 attribute attributes, only slice attributes matching the filter
14929 will be returned. If return_fields is specified, only the
14930 specified details will be returned.</P
14931 ><P
14932 >Users may only query attributes of slices or slivers of which they
14933 are members. PIs may only query attributes of slices or slivers at
14934 their sites, or of which they are members. Admins may query
14935 attributes of any slice or sliver.</P
14936 ></BLOCKQUOTE
14937 ></P
14938 ><P
14939 >Allowed Roles:<A
14940 NAME="AEN4975"
14941 ></A
14942 ><BLOCKQUOTE
14943 CLASS="BLOCKQUOTE"
14944 ><P
14945 >admin, pi, user, node</P
14946 ></BLOCKQUOTE
14947 ></P
14948 ><P
14949 >Parameters:</P
14950 ><P
14951 ></P
14952 ><UL
14953 ><LI
14954 ><P
14955 >&#13;                          <CODE
14956 CLASS="parameter"
14957 >auth</CODE
14958 >
14959 : struct, API authentication structure                  </P
14960 ><P
14961 ></P
14962 ><UL
14963 ><LI
14964 ><P
14965 >&#13;                                          <CODE
14966 CLASS="parameter"
14967 >AuthMethod</CODE
14968 >
14969 : string, Authentication method to use                                  </P
14970 ></LI
14971 ></UL
14972 ></LI
14973 ><LI
14974 ><P
14975 >&#13;                          <CODE
14976 CLASS="parameter"
14977 >slice_attribute_filter</CODE
14978 >
14979 : array of int or struct                        </P
14980 ><P
14981 ></P
14982 ><UL
14983 ><LI
14984 ><P
14985 >&#13;array of int, Slice attribute identifier                                  </P
14986 ></LI
14987 ><LI
14988 ><P
14989 >&#13;struct, Attribute filter                                  </P
14990 ><P
14991 ></P
14992 ><UL
14993 ><LI
14994 ><P
14995 >&#13;                                                          <CODE
14996 CLASS="parameter"
14997 >name</CODE
14998 >
14999 : string or array of string                                                     </P
15000 ><P
15001 ></P
15002 ><UL
15003 ><LI
15004 ><P
15005 >&#13;string, Slice attribute type name                                                                 </P
15006 ></LI
15007 ><LI
15008 ><P
15009 >&#13;array of string, Slice attribute type name                                                                        </P
15010 ></LI
15011 ></UL
15012 ></LI
15013 ><LI
15014 ><P
15015 >&#13;                                                          <CODE
15016 CLASS="parameter"
15017 >slice_id</CODE
15018 >
15019 : int or array of int                                                   </P
15020 ><P
15021 ></P
15022 ><UL
15023 ><LI
15024 ><P
15025 >&#13;int, Slice identifier                                                                     </P
15026 ></LI
15027 ><LI
15028 ><P
15029 >&#13;array of int, Slice identifier                                                                    </P
15030 ></LI
15031 ></UL
15032 ></LI
15033 ><LI
15034 ><P
15035 >&#13;                                                          <CODE
15036 CLASS="parameter"
15037 >slice_attribute_id</CODE
15038 >
15039 : int or array of int                                                   </P
15040 ><P
15041 ></P
15042 ><UL
15043 ><LI
15044 ><P
15045 >&#13;int, Slice attribute identifier                                                                   </P
15046 ></LI
15047 ><LI
15048 ><P
15049 >&#13;array of int, Slice attribute identifier                                                                  </P
15050 ></LI
15051 ></UL
15052 ></LI
15053 ><LI
15054 ><P
15055 >&#13;                                                          <CODE
15056 CLASS="parameter"
15057 >value</CODE
15058 >
15059 : string or array of string                                                     </P
15060 ><P
15061 ></P
15062 ><UL
15063 ><LI
15064 ><P
15065 >&#13;string, Slice attribute value                                                                     </P
15066 ></LI
15067 ><LI
15068 ><P
15069 >&#13;array of string, Slice attribute value                                                                    </P
15070 ></LI
15071 ></UL
15072 ></LI
15073 ><LI
15074 ><P
15075 >&#13;                                                          <CODE
15076 CLASS="parameter"
15077 >attribute_type_id</CODE
15078 >
15079 : int or array of int                                                   </P
15080 ><P
15081 ></P
15082 ><UL
15083 ><LI
15084 ><P
15085 >&#13;int, Slice attribute type identifier                                                                      </P
15086 ></LI
15087 ><LI
15088 ><P
15089 >&#13;array of int, Slice attribute type identifier                                                                     </P
15090 ></LI
15091 ></UL
15092 ></LI
15093 ><LI
15094 ><P
15095 >&#13;                                                          <CODE
15096 CLASS="parameter"
15097 >node_id</CODE
15098 >
15099 : int or array of int                                                   </P
15100 ><P
15101 ></P
15102 ><UL
15103 ><LI
15104 ><P
15105 >&#13;int, Node identifier, if a sliver attribute                                                                       </P
15106 ></LI
15107 ><LI
15108 ><P
15109 >&#13;array of int, Node identifier, if a sliver attribute                                                                      </P
15110 ></LI
15111 ></UL
15112 ></LI
15113 ><LI
15114 ><P
15115 >&#13;                                                          <CODE
15116 CLASS="parameter"
15117 >min_role_id</CODE
15118 >
15119 : int or array of int                                                   </P
15120 ><P
15121 ></P
15122 ><UL
15123 ><LI
15124 ><P
15125 >&#13;int, Minimum (least powerful) role that can set or change this attribute                                                                  </P
15126 ></LI
15127 ><LI
15128 ><P
15129 >&#13;array of int, Minimum (least powerful) role that can set or change this attribute                                                                 </P
15130 ></LI
15131 ></UL
15132 ></LI
15133 ><LI
15134 ><P
15135 >&#13;                                                          <CODE
15136 CLASS="parameter"
15137 >description</CODE
15138 >
15139 : string or array of string                                                     </P
15140 ><P
15141 ></P
15142 ><UL
15143 ><LI
15144 ><P
15145 >&#13;string, Slice attribute type description                                                                  </P
15146 ></LI
15147 ><LI
15148 ><P
15149 >&#13;array of string, Slice attribute type description                                                                 </P
15150 ></LI
15151 ></UL
15152 ></LI
15153 ></UL
15154 ></LI
15155 ></UL
15156 ></LI
15157 ><LI
15158 ><P
15159 >&#13;                          <CODE
15160 CLASS="parameter"
15161 >return_fields</CODE
15162 >
15163 : array, List of fields to return                       </P
15164 ><P
15165 ></P
15166 ><UL
15167 ><LI
15168 ><P
15169 >&#13;string                                    </P
15170 ></LI
15171 ></UL
15172 ></LI
15173 ></UL
15174 ><P
15175 >Returns:</P
15176 ><P
15177 ></P
15178 ><UL
15179 ><LI
15180 ><P
15181 >&#13;array of struct                   </P
15182 ><P
15183 ></P
15184 ><UL
15185 ><LI
15186 ><P
15187 >&#13;                                          <CODE
15188 CLASS="parameter"
15189 >name</CODE
15190 >
15191 : string, Slice attribute type name                                     </P
15192 ></LI
15193 ><LI
15194 ><P
15195 >&#13;                                          <CODE
15196 CLASS="parameter"
15197 >slice_id</CODE
15198 >
15199 : int, Slice identifier                                 </P
15200 ></LI
15201 ><LI
15202 ><P
15203 >&#13;                                          <CODE
15204 CLASS="parameter"
15205 >slice_attribute_id</CODE
15206 >
15207 : int, Slice attribute identifier                                       </P
15208 ></LI
15209 ><LI
15210 ><P
15211 >&#13;                                          <CODE
15212 CLASS="parameter"
15213 >value</CODE
15214 >
15215 : string, Slice attribute value                                 </P
15216 ></LI
15217 ><LI
15218 ><P
15219 >&#13;                                          <CODE
15220 CLASS="parameter"
15221 >attribute_type_id</CODE
15222 >
15223 : int, Slice attribute type identifier                                  </P
15224 ></LI
15225 ><LI
15226 ><P
15227 >&#13;                                          <CODE
15228 CLASS="parameter"
15229 >node_id</CODE
15230 >
15231 : int, Node identifier, if a sliver attribute                                   </P
15232 ></LI
15233 ><LI
15234 ><P
15235 >&#13;                                          <CODE
15236 CLASS="parameter"
15237 >min_role_id</CODE
15238 >
15239 : int, Minimum (least powerful) role that can set or change this attribute                                      </P
15240 ></LI
15241 ><LI
15242 ><P
15243 >&#13;                                          <CODE
15244 CLASS="parameter"
15245 >description</CODE
15246 >
15247 : string, Slice attribute type description                                      </P
15248 ></LI
15249 ></UL
15250 ></LI
15251 ></UL
15252 ></DIV
15253 ><DIV
15254 CLASS="section"
15255 ><HR><H2
15256 CLASS="section"
15257 ><A
15258 NAME="GetSliceAttributeTypes"
15259 >2.89. GetSliceAttributeTypes</A
15260 ></H2
15261 ><P
15262 >Prototype:<A
15263 NAME="AEN5097"
15264 ></A
15265 ><BLOCKQUOTE
15266 CLASS="BLOCKQUOTE"
15267 ><P
15268 >GetSliceAttributeTypes (auth, attribute_type_filter, return_fields)</P
15269 ></BLOCKQUOTE
15270 ></P
15271 ><P
15272 >Description:<A
15273 NAME="AEN5100"
15274 ></A
15275 ><BLOCKQUOTE
15276 CLASS="BLOCKQUOTE"
15277 ><P
15278 >Returns an array of structs containing details about slice
15279 attribute types. If attribute_type_filter is specified and
15280 is an array of slice attribute type identifiers, or a
15281 struct of slice attribute type attributes, only slice attribute
15282 types matching the filter will be returned. If return_fields is
15283 specified, only the specified details will be returned.</P
15284 ></BLOCKQUOTE
15285 ></P
15286 ><P
15287 >Allowed Roles:<A
15288 NAME="AEN5103"
15289 ></A
15290 ><BLOCKQUOTE
15291 CLASS="BLOCKQUOTE"
15292 ><P
15293 >admin, pi, user, tech, node</P
15294 ></BLOCKQUOTE
15295 ></P
15296 ><P
15297 >Parameters:</P
15298 ><P
15299 ></P
15300 ><UL
15301 ><LI
15302 ><P
15303 >&#13;                          <CODE
15304 CLASS="parameter"
15305 >auth</CODE
15306 >
15307 : struct, API authentication structure                  </P
15308 ><P
15309 ></P
15310 ><UL
15311 ><LI
15312 ><P
15313 >&#13;                                          <CODE
15314 CLASS="parameter"
15315 >AuthMethod</CODE
15316 >
15317 : string, Authentication method to use                                  </P
15318 ></LI
15319 ></UL
15320 ></LI
15321 ><LI
15322 ><P
15323 >&#13;                          <CODE
15324 CLASS="parameter"
15325 >attribute_type_filter</CODE
15326 >
15327 : array of int or string or struct                      </P
15328 ><P
15329 ></P
15330 ><UL
15331 ><LI
15332 ><P
15333 >&#13;array of int or string                                    </P
15334 ><P
15335 ></P
15336 ><UL
15337 ><LI
15338 ><P
15339 >&#13;int, Slice attribute type identifier                                                      </P
15340 ></LI
15341 ><LI
15342 ><P
15343 >&#13;string, Slice attribute type name                                                 </P
15344 ></LI
15345 ></UL
15346 ></LI
15347 ><LI
15348 ><P
15349 >&#13;struct, Attribute filter                                  </P
15350 ><P
15351 ></P
15352 ><UL
15353 ><LI
15354 ><P
15355 >&#13;                                                          <CODE
15356 CLASS="parameter"
15357 >attribute_type_id</CODE
15358 >
15359 : int or array of int                                                   </P
15360 ><P
15361 ></P
15362 ><UL
15363 ><LI
15364 ><P
15365 >&#13;int, Slice attribute type identifier                                                                      </P
15366 ></LI
15367 ><LI
15368 ><P
15369 >&#13;array of int, Slice attribute type identifier                                                                     </P
15370 ></LI
15371 ></UL
15372 ></LI
15373 ><LI
15374 ><P
15375 >&#13;                                                          <CODE
15376 CLASS="parameter"
15377 >min_role_id</CODE
15378 >
15379 : int or array of int                                                   </P
15380 ><P
15381 ></P
15382 ><UL
15383 ><LI
15384 ><P
15385 >&#13;int, Minimum (least powerful) role that can set or change this attribute                                                                  </P
15386 ></LI
15387 ><LI
15388 ><P
15389 >&#13;array of int, Minimum (least powerful) role that can set or change this attribute                                                                 </P
15390 ></LI
15391 ></UL
15392 ></LI
15393 ><LI
15394 ><P
15395 >&#13;                                                          <CODE
15396 CLASS="parameter"
15397 >name</CODE
15398 >
15399 : string or array of string                                                     </P
15400 ><P
15401 ></P
15402 ><UL
15403 ><LI
15404 ><P
15405 >&#13;string, Slice attribute type name                                                                 </P
15406 ></LI
15407 ><LI
15408 ><P
15409 >&#13;array of string, Slice attribute type name                                                                        </P
15410 ></LI
15411 ></UL
15412 ></LI
15413 ><LI
15414 ><P
15415 >&#13;                                                          <CODE
15416 CLASS="parameter"
15417 >description</CODE
15418 >
15419 : string or array of string                                                     </P
15420 ><P
15421 ></P
15422 ><UL
15423 ><LI
15424 ><P
15425 >&#13;string, Slice attribute type description                                                                  </P
15426 ></LI
15427 ><LI
15428 ><P
15429 >&#13;array of string, Slice attribute type description                                                                 </P
15430 ></LI
15431 ></UL
15432 ></LI
15433 ></UL
15434 ></LI
15435 ></UL
15436 ></LI
15437 ><LI
15438 ><P
15439 >&#13;                          <CODE
15440 CLASS="parameter"
15441 >return_fields</CODE
15442 >
15443 : array, List of fields to return                       </P
15444 ><P
15445 ></P
15446 ><UL
15447 ><LI
15448 ><P
15449 >&#13;string                                    </P
15450 ></LI
15451 ></UL
15452 ></LI
15453 ></UL
15454 ><P
15455 >Returns:</P
15456 ><P
15457 ></P
15458 ><UL
15459 ><LI
15460 ><P
15461 >&#13;array of struct                   </P
15462 ><P
15463 ></P
15464 ><UL
15465 ><LI
15466 ><P
15467 >&#13;                                          <CODE
15468 CLASS="parameter"
15469 >attribute_type_id</CODE
15470 >
15471 : int, Slice attribute type identifier                                  </P
15472 ></LI
15473 ><LI
15474 ><P
15475 >&#13;                                          <CODE
15476 CLASS="parameter"
15477 >min_role_id</CODE
15478 >
15479 : int, Minimum (least powerful) role that can set or change this attribute                                      </P
15480 ></LI
15481 ><LI
15482 ><P
15483 >&#13;                                          <CODE
15484 CLASS="parameter"
15485 >name</CODE
15486 >
15487 : string, Slice attribute type name                                     </P
15488 ></LI
15489 ><LI
15490 ><P
15491 >&#13;                                          <CODE
15492 CLASS="parameter"
15493 >description</CODE
15494 >
15495 : string, Slice attribute type description                                      </P
15496 ></LI
15497 ></UL
15498 ></LI
15499 ></UL
15500 ></DIV
15501 ><DIV
15502 CLASS="section"
15503 ><HR><H2
15504 CLASS="section"
15505 ><A
15506 NAME="GetSliceInstantiations"
15507 >2.90. GetSliceInstantiations</A
15508 ></H2
15509 ><P
15510 >Prototype:<A
15511 NAME="AEN5186"
15512 ></A
15513 ><BLOCKQUOTE
15514 CLASS="BLOCKQUOTE"
15515 ><P
15516 >GetSliceInstantiations (auth)</P
15517 ></BLOCKQUOTE
15518 ></P
15519 ><P
15520 >Description:<A
15521 NAME="AEN5189"
15522 ></A
15523 ><BLOCKQUOTE
15524 CLASS="BLOCKQUOTE"
15525 ><P
15526 >Returns an array of all valid slice instantiation states.</P
15527 ></BLOCKQUOTE
15528 ></P
15529 ><P
15530 >Allowed Roles:<A
15531 NAME="AEN5192"
15532 ></A
15533 ><BLOCKQUOTE
15534 CLASS="BLOCKQUOTE"
15535 ><P
15536 >admin, pi, user, tech, node</P
15537 ></BLOCKQUOTE
15538 ></P
15539 ><P
15540 >Parameters:</P
15541 ><P
15542 ></P
15543 ><UL
15544 ><LI
15545 ><P
15546 >&#13;                          <CODE
15547 CLASS="parameter"
15548 >auth</CODE
15549 >
15550 : struct, API authentication structure                  </P
15551 ><P
15552 ></P
15553 ><UL
15554 ><LI
15555 ><P
15556 >&#13;                                          <CODE
15557 CLASS="parameter"
15558 >AuthMethod</CODE
15559 >
15560 : string, Authentication method to use                                  </P
15561 ></LI
15562 ></UL
15563 ></LI
15564 ></UL
15565 ><P
15566 >Returns:</P
15567 ><P
15568 ></P
15569 ><UL
15570 ><LI
15571 ><P
15572 >&#13;array of string, Slice instantiation state                        </P
15573 ></LI
15574 ></UL
15575 ></DIV
15576 ><DIV
15577 CLASS="section"
15578 ><HR><H2
15579 CLASS="section"
15580 ><A
15581 NAME="GetSlices"
15582 >2.91. GetSlices</A
15583 ></H2
15584 ><P
15585 >Prototype:<A
15586 NAME="AEN5210"
15587 ></A
15588 ><BLOCKQUOTE
15589 CLASS="BLOCKQUOTE"
15590 ><P
15591 >GetSlices (auth, slice_filter, return_fields)</P
15592 ></BLOCKQUOTE
15593 ></P
15594 ><P
15595 >Description:<A
15596 NAME="AEN5213"
15597 ></A
15598 ><BLOCKQUOTE
15599 CLASS="BLOCKQUOTE"
15600 ><P
15601 >Returns an array of structs containing details about slices. If
15602 slice_filter is specified and is an array of slice identifiers or
15603 slice names, or a struct of slice attributes, only slices matching
15604 the filter will be returned. If return_fields is specified, only the
15605 specified details will be returned.</P
15606 ><P
15607 >Users may only query slices of which they are members. PIs may
15608 query any of the slices at their sites. Admins and nodes may query
15609 any slice. If a slice that cannot be queried is specified in
15610 slice_filter, details about that slice will not be returned.</P
15611 ></BLOCKQUOTE
15612 ></P
15613 ><P
15614 >Allowed Roles:<A
15615 NAME="AEN5217"
15616 ></A
15617 ><BLOCKQUOTE
15618 CLASS="BLOCKQUOTE"
15619 ><P
15620 >admin, pi, user, node</P
15621 ></BLOCKQUOTE
15622 ></P
15623 ><P
15624 >Parameters:</P
15625 ><P
15626 ></P
15627 ><UL
15628 ><LI
15629 ><P
15630 >&#13;                          <CODE
15631 CLASS="parameter"
15632 >auth</CODE
15633 >
15634 : struct, API authentication structure                  </P
15635 ><P
15636 ></P
15637 ><UL
15638 ><LI
15639 ><P
15640 >&#13;                                          <CODE
15641 CLASS="parameter"
15642 >AuthMethod</CODE
15643 >
15644 : string, Authentication method to use                                  </P
15645 ></LI
15646 ></UL
15647 ></LI
15648 ><LI
15649 ><P
15650 >&#13;                          <CODE
15651 CLASS="parameter"
15652 >slice_filter</CODE
15653 >
15654 : array of int or string or struct                      </P
15655 ><P
15656 ></P
15657 ><UL
15658 ><LI
15659 ><P
15660 >&#13;array of int or string                                    </P
15661 ><P
15662 ></P
15663 ><UL
15664 ><LI
15665 ><P
15666 >&#13;int, Slice identifier                                                     </P
15667 ></LI
15668 ><LI
15669 ><P
15670 >&#13;string, Slice name                                                        </P
15671 ></LI
15672 ></UL
15673 ></LI
15674 ><LI
15675 ><P
15676 >&#13;struct, Attribute filter                                  </P
15677 ><P
15678 ></P
15679 ><UL
15680 ><LI
15681 ><P
15682 >&#13;                                                          <CODE
15683 CLASS="parameter"
15684 >creator_person_id</CODE
15685 >
15686 : int or array of int                                                   </P
15687 ><P
15688 ></P
15689 ><UL
15690 ><LI
15691 ><P
15692 >&#13;int, Identifier of the account that created this slice                                                                    </P
15693 ></LI
15694 ><LI
15695 ><P
15696 >&#13;array of int, Identifier of the account that created this slice                                                                   </P
15697 ></LI
15698 ></UL
15699 ></LI
15700 ><LI
15701 ><P
15702 >&#13;                                                          <CODE
15703 CLASS="parameter"
15704 >instantiation</CODE
15705 >
15706 : string or array of string                                                     </P
15707 ><P
15708 ></P
15709 ><UL
15710 ><LI
15711 ><P
15712 >&#13;string, Slice instantiation state                                                                 </P
15713 ></LI
15714 ><LI
15715 ><P
15716 >&#13;array of string, Slice instantiation state                                                                        </P
15717 ></LI
15718 ></UL
15719 ></LI
15720 ><LI
15721 ><P
15722 >&#13;                                                          <CODE
15723 CLASS="parameter"
15724 >name</CODE
15725 >
15726 : string or array of string                                                     </P
15727 ><P
15728 ></P
15729 ><UL
15730 ><LI
15731 ><P
15732 >&#13;string, Slice name                                                                        </P
15733 ></LI
15734 ><LI
15735 ><P
15736 >&#13;array of string, Slice name                                                                       </P
15737 ></LI
15738 ></UL
15739 ></LI
15740 ><LI
15741 ><P
15742 >&#13;                                                          <CODE
15743 CLASS="parameter"
15744 >slice_id</CODE
15745 >
15746 : int or array of int                                                   </P
15747 ><P
15748 ></P
15749 ><UL
15750 ><LI
15751 ><P
15752 >&#13;int, Slice identifier                                                                     </P
15753 ></LI
15754 ><LI
15755 ><P
15756 >&#13;array of int, Slice identifier                                                                    </P
15757 ></LI
15758 ></UL
15759 ></LI
15760 ><LI
15761 ><P
15762 >&#13;                                                          <CODE
15763 CLASS="parameter"
15764 >created</CODE
15765 >
15766 : int or array of int                                                   </P
15767 ><P
15768 ></P
15769 ><UL
15770 ><LI
15771 ><P
15772 >&#13;int, Date and time when slice was created, in seconds since UNIX epoch                                                                    </P
15773 ></LI
15774 ><LI
15775 ><P
15776 >&#13;array of int, Date and time when slice was created, in seconds since UNIX epoch                                                                   </P
15777 ></LI
15778 ></UL
15779 ></LI
15780 ><LI
15781 ><P
15782 >&#13;                                                          <CODE
15783 CLASS="parameter"
15784 >url</CODE
15785 >
15786 : string or array of string                                                     </P
15787 ><P
15788 ></P
15789 ><UL
15790 ><LI
15791 ><P
15792 >&#13;string, URL further describing this slice                                                                 </P
15793 ></LI
15794 ><LI
15795 ><P
15796 >&#13;array of string, URL further describing this slice                                                                        </P
15797 ></LI
15798 ></UL
15799 ></LI
15800 ><LI
15801 ><P
15802 >&#13;                                                          <CODE
15803 CLASS="parameter"
15804 >max_nodes</CODE
15805 >
15806 : int or array of int                                                   </P
15807 ><P
15808 ></P
15809 ><UL
15810 ><LI
15811 ><P
15812 >&#13;int, Maximum number of nodes that can be assigned to this slice                                                                   </P
15813 ></LI
15814 ><LI
15815 ><P
15816 >&#13;array of int, Maximum number of nodes that can be assigned to this slice                                                                  </P
15817 ></LI
15818 ></UL
15819 ></LI
15820 ><LI
15821 ><P
15822 >&#13;                                                          <CODE
15823 CLASS="parameter"
15824 >expires</CODE
15825 >
15826 : int or array of int                                                   </P
15827 ><P
15828 ></P
15829 ><UL
15830 ><LI
15831 ><P
15832 >&#13;int, Date and time when slice expires, in seconds since UNIX epoch                                                                        </P
15833 ></LI
15834 ><LI
15835 ><P
15836 >&#13;array of int, Date and time when slice expires, in seconds since UNIX epoch                                                                       </P
15837 ></LI
15838 ></UL
15839 ></LI
15840 ><LI
15841 ><P
15842 >&#13;                                                          <CODE
15843 CLASS="parameter"
15844 >site_id</CODE
15845 >
15846 : int or array of int                                                   </P
15847 ><P
15848 ></P
15849 ><UL
15850 ><LI
15851 ><P
15852 >&#13;int, Identifier of the site to which this slice belongs                                                                   </P
15853 ></LI
15854 ><LI
15855 ><P
15856 >&#13;array of int, Identifier of the site to which this slice belongs                                                                  </P
15857 ></LI
15858 ></UL
15859 ></LI
15860 ><LI
15861 ><P
15862 >&#13;                                                          <CODE
15863 CLASS="parameter"
15864 >peer_slice_id</CODE
15865 >
15866 : int or array of int                                                   </P
15867 ><P
15868 ></P
15869 ><UL
15870 ><LI
15871 ><P
15872 >&#13;int, Foreign slice identifier at peer                                                                     </P
15873 ></LI
15874 ><LI
15875 ><P
15876 >&#13;array of int, Foreign slice identifier at peer                                                                    </P
15877 ></LI
15878 ></UL
15879 ></LI
15880 ><LI
15881 ><P
15882 >&#13;                                                          <CODE
15883 CLASS="parameter"
15884 >peer_id</CODE
15885 >
15886 : int or array of int                                                   </P
15887 ><P
15888 ></P
15889 ><UL
15890 ><LI
15891 ><P
15892 >&#13;int, Peer to which this slice belongs                                                                     </P
15893 ></LI
15894 ><LI
15895 ><P
15896 >&#13;array of int, Peer to which this slice belongs                                                                    </P
15897 ></LI
15898 ></UL
15899 ></LI
15900 ><LI
15901 ><P
15902 >&#13;                                                          <CODE
15903 CLASS="parameter"
15904 >description</CODE
15905 >
15906 : string or array of string                                                     </P
15907 ><P
15908 ></P
15909 ><UL
15910 ><LI
15911 ><P
15912 >&#13;string, Slice description                                                                 </P
15913 ></LI
15914 ><LI
15915 ><P
15916 >&#13;array of string, Slice description                                                                        </P
15917 ></LI
15918 ></UL
15919 ></LI
15920 ></UL
15921 ></LI
15922 ></UL
15923 ></LI
15924 ><LI
15925 ><P
15926 >&#13;                          <CODE
15927 CLASS="parameter"
15928 >return_fields</CODE
15929 >
15930 : array, List of fields to return                       </P
15931 ><P
15932 ></P
15933 ><UL
15934 ><LI
15935 ><P
15936 >&#13;string                                    </P
15937 ></LI
15938 ></UL
15939 ></LI
15940 ></UL
15941 ><P
15942 >Returns:</P
15943 ><P
15944 ></P
15945 ><UL
15946 ><LI
15947 ><P
15948 >&#13;array of struct                   </P
15949 ><P
15950 ></P
15951 ><UL
15952 ><LI
15953 ><P
15954 >&#13;                                          <CODE
15955 CLASS="parameter"
15956 >creator_person_id</CODE
15957 >
15958 : int, Identifier of the account that created this slice                                        </P
15959 ></LI
15960 ><LI
15961 ><P
15962 >&#13;                                          <CODE
15963 CLASS="parameter"
15964 >instantiation</CODE
15965 >
15966 : string, Slice instantiation state                                     </P
15967 ></LI
15968 ><LI
15969 ><P
15970 >&#13;                                          <CODE
15971 CLASS="parameter"
15972 >slice_attribute_ids</CODE
15973 >
15974 : array, List of slice attributes                                       </P
15975 ><P
15976 ></P
15977 ><UL
15978 ><LI
15979 ><P
15980 >&#13;int                                                       </P
15981 ></LI
15982 ></UL
15983 ></LI
15984 ><LI
15985 ><P
15986 >&#13;                                          <CODE
15987 CLASS="parameter"
15988 >name</CODE
15989 >
15990 : string, Slice name                                    </P
15991 ></LI
15992 ><LI
15993 ><P
15994 >&#13;                                          <CODE
15995 CLASS="parameter"
15996 >slice_id</CODE
15997 >
15998 : int, Slice identifier                                 </P
15999 ></LI
16000 ><LI
16001 ><P
16002 >&#13;                                          <CODE
16003 CLASS="parameter"
16004 >created</CODE
16005 >
16006 : int, Date and time when slice was created, in seconds since UNIX epoch                                        </P
16007 ></LI
16008 ><LI
16009 ><P
16010 >&#13;                                          <CODE
16011 CLASS="parameter"
16012 >url</CODE
16013 >
16014 : string, URL further describing this slice                                     </P
16015 ></LI
16016 ><LI
16017 ><P
16018 >&#13;                                          <CODE
16019 CLASS="parameter"
16020 >max_nodes</CODE
16021 >
16022 : int, Maximum number of nodes that can be assigned to this slice                                       </P
16023 ></LI
16024 ><LI
16025 ><P
16026 >&#13;                                          <CODE
16027 CLASS="parameter"
16028 >person_ids</CODE
16029 >
16030 : array, List of accounts that can use this slice                                       </P
16031 ><P
16032 ></P
16033 ><UL
16034 ><LI
16035 ><P
16036 >&#13;int                                                       </P
16037 ></LI
16038 ></UL
16039 ></LI
16040 ><LI
16041 ><P
16042 >&#13;                                          <CODE
16043 CLASS="parameter"
16044 >expires</CODE
16045 >
16046 : int, Date and time when slice expires, in seconds since UNIX epoch                                    </P
16047 ></LI
16048 ><LI
16049 ><P
16050 >&#13;                                          <CODE
16051 CLASS="parameter"
16052 >site_id</CODE
16053 >
16054 : int, Identifier of the site to which this slice belongs                                       </P
16055 ></LI
16056 ><LI
16057 ><P
16058 >&#13;                                          <CODE
16059 CLASS="parameter"
16060 >peer_slice_id</CODE
16061 >
16062 : int, Foreign slice identifier at peer                                 </P
16063 ></LI
16064 ><LI
16065 ><P
16066 >&#13;                                          <CODE
16067 CLASS="parameter"
16068 >node_ids</CODE
16069 >
16070 : array, List of nodes in this slice                                    </P
16071 ><P
16072 ></P
16073 ><UL
16074 ><LI
16075 ><P
16076 >&#13;int                                                       </P
16077 ></LI
16078 ></UL
16079 ></LI
16080 ><LI
16081 ><P
16082 >&#13;                                          <CODE
16083 CLASS="parameter"
16084 >peer_id</CODE
16085 >
16086 : int, Peer to which this slice belongs                                 </P
16087 ></LI
16088 ><LI
16089 ><P
16090 >&#13;                                          <CODE
16091 CLASS="parameter"
16092 >description</CODE
16093 >
16094 : string, Slice description                                     </P
16095 ></LI
16096 ></UL
16097 ></LI
16098 ></UL
16099 ></DIV
16100 ><DIV
16101 CLASS="section"
16102 ><HR><H2
16103 CLASS="section"
16104 ><A
16105 NAME="GetSliceTicket"
16106 >2.92. GetSliceTicket</A
16107 ></H2
16108 ><P
16109 >Prototype:<A
16110 NAME="AEN5406"
16111 ></A
16112 ><BLOCKQUOTE
16113 CLASS="BLOCKQUOTE"
16114 ><P
16115 >GetSliceTicket (auth, slice_id_or_name)</P
16116 ></BLOCKQUOTE
16117 ></P
16118 ><P
16119 >Description:<A
16120 NAME="AEN5409"
16121 ></A
16122 ><BLOCKQUOTE
16123 CLASS="BLOCKQUOTE"
16124 ><P
16125 >Returns a ticket for, or signed representation of, the specified
16126 slice. Slice tickets may be used to manually instantiate or update
16127 a slice on a node. Present this ticket to the local Node Manager
16128 interface to redeem it.</P
16129 ><P
16130 >If the slice has not been added to a node with AddSliceToNodes,
16131 and the ticket is redeemed on that node, it will be deleted the
16132 next time the Node Manager contacts the API.</P
16133 ><P
16134 >Users may only obtain tickets for slices of which they are
16135 members. PIs may obtain tickets for any of the slices at their
16136 sites, or any slices of which they are members. Admins may obtain
16137 tickets for any slice.</P
16138 ><P
16139 >Returns 1 if successful, faults otherwise.</P
16140 ></BLOCKQUOTE
16141 ></P
16142 ><P
16143 >Allowed Roles:<A
16144 NAME="AEN5415"
16145 ></A
16146 ><BLOCKQUOTE
16147 CLASS="BLOCKQUOTE"
16148 ><P
16149 >admin, pi, user, peer</P
16150 ></BLOCKQUOTE
16151 ></P
16152 ><P
16153 >Parameters:</P
16154 ><P
16155 ></P
16156 ><UL
16157 ><LI
16158 ><P
16159 >&#13;                          <CODE
16160 CLASS="parameter"
16161 >auth</CODE
16162 >
16163 : struct, API authentication structure                  </P
16164 ><P
16165 ></P
16166 ><UL
16167 ><LI
16168 ><P
16169 >&#13;                                          <CODE
16170 CLASS="parameter"
16171 >AuthMethod</CODE
16172 >
16173 : string, Authentication method to use                                  </P
16174 ></LI
16175 ></UL
16176 ></LI
16177 ><LI
16178 ><P
16179 >&#13;                          <CODE
16180 CLASS="parameter"
16181 >slice_id_or_name</CODE
16182 >
16183 : int or string                 </P
16184 ><P
16185 ></P
16186 ><UL
16187 ><LI
16188 ><P
16189 >&#13;int, Slice identifier                                     </P
16190 ></LI
16191 ><LI
16192 ><P
16193 >&#13;string, Slice name                                        </P
16194 ></LI
16195 ></UL
16196 ></LI
16197 ></UL
16198 ><P
16199 >Returns:</P
16200 ><P
16201 ></P
16202 ><UL
16203 ><LI
16204 ><P
16205 >&#13;string, Signed slice ticket                       </P
16206 ></LI
16207 ></UL
16208 ></DIV
16209 ><DIV
16210 CLASS="section"
16211 ><HR><H2
16212 CLASS="section"
16213 ><A
16214 NAME="GetSlivers"
16215 >2.93. GetSlivers</A
16216 ></H2
16217 ><P
16218 >Prototype:<A
16219 NAME="AEN5441"
16220 ></A
16221 ><BLOCKQUOTE
16222 CLASS="BLOCKQUOTE"
16223 ><P
16224 >GetSlivers (auth, node_id_or_hostname)</P
16225 ></BLOCKQUOTE
16226 ></P
16227 ><P
16228 >Description:<A
16229 NAME="AEN5444"
16230 ></A
16231 ><BLOCKQUOTE
16232 CLASS="BLOCKQUOTE"
16233 ><P
16234 >Returns a struct containing information about the specified node
16235 (or calling node, if called by a node and node_id_or_hostname is
16236 not specified), including the current set of slivers bound to the
16237 node.</P
16238 ><P
16239 >All of the information returned by this call can be gathered from
16240 other calls, e.g. GetNodes, GetNodeNetworks, GetSlices, etc. This
16241 function exists almost solely for the benefit of Node Manager.</P
16242 ></BLOCKQUOTE
16243 ></P
16244 ><P
16245 >Allowed Roles:<A
16246 NAME="AEN5448"
16247 ></A
16248 ><BLOCKQUOTE
16249 CLASS="BLOCKQUOTE"
16250 ><P
16251 >admin, node</P
16252 ></BLOCKQUOTE
16253 ></P
16254 ><P
16255 >Parameters:</P
16256 ><P
16257 ></P
16258 ><UL
16259 ><LI
16260 ><P
16261 >&#13;                          <CODE
16262 CLASS="parameter"
16263 >auth</CODE
16264 >
16265 : struct, API authentication structure                  </P
16266 ><P
16267 ></P
16268 ><UL
16269 ><LI
16270 ><P
16271 >&#13;                                          <CODE
16272 CLASS="parameter"
16273 >AuthMethod</CODE
16274 >
16275 : string, Authentication method to use                                  </P
16276 ></LI
16277 ></UL
16278 ></LI
16279 ><LI
16280 ><P
16281 >&#13;                          <CODE
16282 CLASS="parameter"
16283 >node_id_or_hostname</CODE
16284 >
16285 : int or string                 </P
16286 ><P
16287 ></P
16288 ><UL
16289 ><LI
16290 ><P
16291 >&#13;int, Node identifier                                      </P
16292 ></LI
16293 ><LI
16294 ><P
16295 >&#13;string, Fully qualified hostname                                  </P
16296 ></LI
16297 ></UL
16298 ></LI
16299 ></UL
16300 ><P
16301 >Returns:</P
16302 ><P
16303 ></P
16304 ><UL
16305 ><LI
16306 ><P
16307 >&#13;struct                    </P
16308 ><P
16309 ></P
16310 ><UL
16311 ><LI
16312 ><P
16313 >&#13;                                          <CODE
16314 CLASS="parameter"
16315 >timestamp</CODE
16316 >
16317 : int, Timestamp of this call, in seconds since UNIX epoch                                      </P
16318 ></LI
16319 ><LI
16320 ><P
16321 >&#13;                                          <CODE
16322 CLASS="parameter"
16323 >hostname</CODE
16324 >
16325 : string, Fully qualified hostname                                      </P
16326 ></LI
16327 ><LI
16328 ><P
16329 >&#13;                                          <CODE
16330 CLASS="parameter"
16331 >conf_files</CODE
16332 >
16333 : array of struct                                       </P
16334 ><P
16335 ></P
16336 ><UL
16337 ><LI
16338 ><P
16339 >&#13;                                                          <CODE
16340 CLASS="parameter"
16341 >file_owner</CODE
16342 >
16343 : string, chown(1) owner                                                        </P
16344 ></LI
16345 ><LI
16346 ><P
16347 >&#13;                                                          <CODE
16348 CLASS="parameter"
16349 >postinstall_cmd</CODE
16350 >
16351 : string, Shell command to execute after installing                                                     </P
16352 ></LI
16353 ><LI
16354 ><P
16355 >&#13;                                                          <CODE
16356 CLASS="parameter"
16357 >error_cmd</CODE
16358 >
16359 : string, Shell command to execute if any error occurs                                                  </P
16360 ></LI
16361 ><LI
16362 ><P
16363 >&#13;                                                          <CODE
16364 CLASS="parameter"
16365 >preinstall_cmd</CODE
16366 >
16367 : string, Shell command to execute prior to installing                                                  </P
16368 ></LI
16369 ><LI
16370 ><P
16371 >&#13;                                                          <CODE
16372 CLASS="parameter"
16373 >node_ids</CODE
16374 >
16375 : int, List of nodes linked to this file                                                        </P
16376 ></LI
16377 ><LI
16378 ><P
16379 >&#13;                                                          <CODE
16380 CLASS="parameter"
16381 >dest</CODE
16382 >
16383 : string, Absolute path where file should be installed                                                  </P
16384 ></LI
16385 ><LI
16386 ><P
16387 >&#13;                                                          <CODE
16388 CLASS="parameter"
16389 >ignore_cmd_errors</CODE
16390 >
16391 : boolean, Install file anyway even if an error occurs                                                  </P
16392 ></LI
16393 ><LI
16394 ><P
16395 >&#13;                                                          <CODE
16396 CLASS="parameter"
16397 >enabled</CODE
16398 >
16399 : boolean, Configuration file is active                                                 </P
16400 ></LI
16401 ><LI
16402 ><P
16403 >&#13;                                                          <CODE
16404 CLASS="parameter"
16405 >conf_file_id</CODE
16406 >
16407 : int, Configuration file identifier                                                    </P
16408 ></LI
16409 ><LI
16410 ><P
16411 >&#13;                                                          <CODE
16412 CLASS="parameter"
16413 >file_permissions</CODE
16414 >
16415 : string, chmod(1) permissions                                                  </P
16416 ></LI
16417 ><LI
16418 ><P
16419 >&#13;                                                          <CODE
16420 CLASS="parameter"
16421 >source</CODE
16422 >
16423 : string, Relative path on the boot server where file can be downloaded                                                 </P
16424 ></LI
16425 ><LI
16426 ><P
16427 >&#13;                                                          <CODE
16428 CLASS="parameter"
16429 >nodegroup_ids</CODE
16430 >
16431 : int, List of node groups linked to this file                                                  </P
16432 ></LI
16433 ><LI
16434 ><P
16435 >&#13;                                                          <CODE
16436 CLASS="parameter"
16437 >always_update</CODE
16438 >
16439 : boolean, Always attempt to install file even if unchanged                                                     </P
16440 ></LI
16441 ><LI
16442 ><P
16443 >&#13;                                                          <CODE
16444 CLASS="parameter"
16445 >file_group</CODE
16446 >
16447 : string, chgrp(1) owner                                                        </P
16448 ></LI
16449 ></UL
16450 ></LI
16451 ><LI
16452 ><P
16453 >&#13;                                          <CODE
16454 CLASS="parameter"
16455 >node_id</CODE
16456 >
16457 : int, Node identifier                                  </P
16458 ></LI
16459 ><LI
16460 ><P
16461 >&#13;                                          <CODE
16462 CLASS="parameter"
16463 >groups</CODE
16464 >
16465 : array of string, Node group name                                      </P
16466 ></LI
16467 ><LI
16468 ><P
16469 >&#13;                                          <CODE
16470 CLASS="parameter"
16471 >networks</CODE
16472 >
16473 : array of struct                                       </P
16474 ><P
16475 ></P
16476 ><UL
16477 ><LI
16478 ><P
16479 >&#13;                                                          <CODE
16480 CLASS="parameter"
16481 >broadcast</CODE
16482 >
16483 : string, Network broadcast address                                                     </P
16484 ></LI
16485 ><LI
16486 ><P
16487 >&#13;                                                          <CODE
16488 CLASS="parameter"
16489 >is_primary</CODE
16490 >
16491 : boolean, Is the primary interface for this node                                                       </P
16492 ></LI
16493 ><LI
16494 ><P
16495 >&#13;                                                          <CODE
16496 CLASS="parameter"
16497 >network</CODE
16498 >
16499 : string, Subnet address                                                        </P
16500 ></LI
16501 ><LI
16502 ><P
16503 >&#13;                                                          <CODE
16504 CLASS="parameter"
16505 >ip</CODE
16506 >
16507 : string, IP address                                                    </P
16508 ></LI
16509 ><LI
16510 ><P
16511 >&#13;                                                          <CODE
16512 CLASS="parameter"
16513 >dns1</CODE
16514 >
16515 : string, IP address of primary DNS server                                                      </P
16516 ></LI
16517 ><LI
16518 ><P
16519 >&#13;                                                          <CODE
16520 CLASS="parameter"
16521 >hostname</CODE
16522 >
16523 : string, (Optional) Hostname                                                   </P
16524 ></LI
16525 ><LI
16526 ><P
16527 >&#13;                                                          <CODE
16528 CLASS="parameter"
16529 >netmask</CODE
16530 >
16531 : string, Subnet mask                                                   </P
16532 ></LI
16533 ><LI
16534 ><P
16535 >&#13;                                                          <CODE
16536 CLASS="parameter"
16537 >gateway</CODE
16538 >
16539 : string, IP address of primary gateway                                                 </P
16540 ></LI
16541 ><LI
16542 ><P
16543 >&#13;                                                          <CODE
16544 CLASS="parameter"
16545 >nodenetwork_id</CODE
16546 >
16547 : int, Node interface identifier                                                        </P
16548 ></LI
16549 ><LI
16550 ><P
16551 >&#13;                                                          <CODE
16552 CLASS="parameter"
16553 >mac</CODE
16554 >
16555 : string, MAC address                                                   </P
16556 ></LI
16557 ><LI
16558 ><P
16559 >&#13;                                                          <CODE
16560 CLASS="parameter"
16561 >node_id</CODE
16562 >
16563 : int, Node associated with this interface                                                      </P
16564 ></LI
16565 ><LI
16566 ><P
16567 >&#13;                                                          <CODE
16568 CLASS="parameter"
16569 >dns2</CODE
16570 >
16571 : string, IP address of secondary DNS server                                                    </P
16572 ></LI
16573 ><LI
16574 ><P
16575 >&#13;                                                          <CODE
16576 CLASS="parameter"
16577 >bwlimit</CODE
16578 >
16579 : int, Bandwidth limit                                                  </P
16580 ></LI
16581 ><LI
16582 ><P
16583 >&#13;                                                          <CODE
16584 CLASS="parameter"
16585 >type</CODE
16586 >
16587 : string, Address type (e.g., 'ipv4')                                                   </P
16588 ></LI
16589 ><LI
16590 ><P
16591 >&#13;                                                          <CODE
16592 CLASS="parameter"
16593 >method</CODE
16594 >
16595 : string, Addressing method (e.g., 'static' or 'dhcp')                                                  </P
16596 ></LI
16597 ></UL
16598 ></LI
16599 ><LI
16600 ><P
16601 >&#13;                                          <CODE
16602 CLASS="parameter"
16603 >slivers</CODE
16604 >
16605 : array of struct                                       </P
16606 ><P
16607 ></P
16608 ><UL
16609 ><LI
16610 ><P
16611 >&#13;                                                          <CODE
16612 CLASS="parameter"
16613 >instantiation</CODE
16614 >
16615 : string, Slice instantiation state                                                     </P
16616 ></LI
16617 ><LI
16618 ><P
16619 >&#13;                                                          <CODE
16620 CLASS="parameter"
16621 >name</CODE
16622 >
16623 : string, Slice name                                                    </P
16624 ></LI
16625 ><LI
16626 ><P
16627 >&#13;                                                          <CODE
16628 CLASS="parameter"
16629 >slice_id</CODE
16630 >
16631 : int, Slice identifier                                                 </P
16632 ></LI
16633 ><LI
16634 ><P
16635 >&#13;                                                          <CODE
16636 CLASS="parameter"
16637 >keys</CODE
16638 >
16639 : array of struct                                                       </P
16640 ><P
16641 ></P
16642 ><UL
16643 ><LI
16644 ><P
16645 >&#13;                                                                          <CODE
16646 CLASS="parameter"
16647 >key_type</CODE
16648 >
16649 : string, Key type                                                                      </P
16650 ></LI
16651 ><LI
16652 ><P
16653 >&#13;                                                                          <CODE
16654 CLASS="parameter"
16655 >key</CODE
16656 >
16657 : string, Key value                                                                     </P
16658 ></LI
16659 ></UL
16660 ></LI
16661 ><LI
16662 ><P
16663 >&#13;                                                          <CODE
16664 CLASS="parameter"
16665 >expires</CODE
16666 >
16667 : int, Date and time when slice expires, in seconds since UNIX epoch                                                    </P
16668 ></LI
16669 ><LI
16670 ><P
16671 >&#13;                                                          <CODE
16672 CLASS="parameter"
16673 >attributes</CODE
16674 >
16675 : array of struct                                                       </P
16676 ><P
16677 ></P
16678 ><UL
16679 ><LI
16680 ><P
16681 >&#13;                                                                          <CODE
16682 CLASS="parameter"
16683 >name</CODE
16684 >
16685 : string, Slice attribute type name                                                                     </P
16686 ></LI
16687 ><LI
16688 ><P
16689 >&#13;                                                                          <CODE
16690 CLASS="parameter"
16691 >value</CODE
16692 >
16693 : string, Slice attribute value                                                                 </P
16694 ></LI
16695 ></UL
16696 ></LI
16697 ></UL
16698 ></LI
16699 ></UL
16700 ></LI
16701 ></UL
16702 ></DIV
16703 ><DIV
16704 CLASS="section"
16705 ><HR><H2
16706 CLASS="section"
16707 ><A
16708 NAME="NotifyPersons"
16709 >2.94. NotifyPersons</A
16710 ></H2
16711 ><P
16712 >Prototype:<A
16713 NAME="AEN5618"
16714 ></A
16715 ><BLOCKQUOTE
16716 CLASS="BLOCKQUOTE"
16717 ><P
16718 >NotifyPersons (auth, person_filter, subject, body)</P
16719 ></BLOCKQUOTE
16720 ></P
16721 ><P
16722 >Description:<A
16723 NAME="AEN5621"
16724 ></A
16725 ><BLOCKQUOTE
16726 CLASS="BLOCKQUOTE"
16727 ><P
16728 >Sends an e-mail message to the specified users. If person_filter
16729 is specified and is an array of user identifiers or usernames, or
16730 a struct of user attributes, only users matching the filter will
16731 receive the message.</P
16732 ><P
16733 >Returns 1 if successful.</P
16734 ></BLOCKQUOTE
16735 ></P
16736 ><P
16737 >Allowed Roles:<A
16738 NAME="AEN5625"
16739 ></A
16740 ><BLOCKQUOTE
16741 CLASS="BLOCKQUOTE"
16742 ><P
16743 >admin, node</P
16744 ></BLOCKQUOTE
16745 ></P
16746 ><P
16747 >Parameters:</P
16748 ><P
16749 ></P
16750 ><UL
16751 ><LI
16752 ><P
16753 >&#13;                          <CODE
16754 CLASS="parameter"
16755 >auth</CODE
16756 >
16757 : struct, API authentication structure                  </P
16758 ><P
16759 ></P
16760 ><UL
16761 ><LI
16762 ><P
16763 >&#13;                                          <CODE
16764 CLASS="parameter"
16765 >AuthMethod</CODE
16766 >
16767 : string, Authentication method to use                                  </P
16768 ></LI
16769 ></UL
16770 ></LI
16771 ><LI
16772 ><P
16773 >&#13;                          <CODE
16774 CLASS="parameter"
16775 >person_filter</CODE
16776 >
16777 : array of int or string or struct                      </P
16778 ><P
16779 ></P
16780 ><UL
16781 ><LI
16782 ><P
16783 >&#13;array of int or string                                    </P
16784 ><P
16785 ></P
16786 ><UL
16787 ><LI
16788 ><P
16789 >&#13;int, User identifier                                                      </P
16790 ></LI
16791 ><LI
16792 ><P
16793 >&#13;string, Primary e-mail address                                                    </P
16794 ></LI
16795 ></UL
16796 ></LI
16797 ><LI
16798 ><P
16799 >&#13;struct, Attribute filter                                  </P
16800 ><P
16801 ></P
16802 ><UL
16803 ><LI
16804 ><P
16805 >&#13;                                                          <CODE
16806 CLASS="parameter"
16807 >bio</CODE
16808 >
16809 : string or array of string                                                     </P
16810 ><P
16811 ></P
16812 ><UL
16813 ><LI
16814 ><P
16815 >&#13;string, Biography                                                                 </P
16816 ></LI
16817 ><LI
16818 ><P
16819 >&#13;array of string, Biography                                                                        </P
16820 ></LI
16821 ></UL
16822 ></LI
16823 ><LI
16824 ><P
16825 >&#13;                                                          <CODE
16826 CLASS="parameter"
16827 >first_name</CODE
16828 >
16829 : string or array of string                                                     </P
16830 ><P
16831 ></P
16832 ><UL
16833 ><LI
16834 ><P
16835 >&#13;string, Given name                                                                        </P
16836 ></LI
16837 ><LI
16838 ><P
16839 >&#13;array of string, Given name                                                                       </P
16840 ></LI
16841 ></UL
16842 ></LI
16843 ><LI
16844 ><P
16845 >&#13;                                                          <CODE
16846 CLASS="parameter"
16847 >last_name</CODE
16848 >
16849 : string or array of string                                                     </P
16850 ><P
16851 ></P
16852 ><UL
16853 ><LI
16854 ><P
16855 >&#13;string, Surname                                                                   </P
16856 ></LI
16857 ><LI
16858 ><P
16859 >&#13;array of string, Surname                                                                  </P
16860 ></LI
16861 ></UL
16862 ></LI
16863 ><LI
16864 ><P
16865 >&#13;                                                          <CODE
16866 CLASS="parameter"
16867 >last_updated</CODE
16868 >
16869 : int or array of int                                                   </P
16870 ><P
16871 ></P
16872 ><UL
16873 ><LI
16874 ><P
16875 >&#13;int, Date and time of last update                                                                 </P
16876 ></LI
16877 ><LI
16878 ><P
16879 >&#13;array of int, Date and time of last update                                                                        </P
16880 ></LI
16881 ></UL
16882 ></LI
16883 ><LI
16884 ><P
16885 >&#13;                                                          <CODE
16886 CLASS="parameter"
16887 >title</CODE
16888 >
16889 : string or array of string                                                     </P
16890 ><P
16891 ></P
16892 ><UL
16893 ><LI
16894 ><P
16895 >&#13;string, Title                                                                     </P
16896 ></LI
16897 ><LI
16898 ><P
16899 >&#13;array of string, Title                                                                    </P
16900 ></LI
16901 ></UL
16902 ></LI
16903 ><LI
16904 ><P
16905 >&#13;                                                          <CODE
16906 CLASS="parameter"
16907 >url</CODE
16908 >
16909 : string or array of string                                                     </P
16910 ><P
16911 ></P
16912 ><UL
16913 ><LI
16914 ><P
16915 >&#13;string, Home page                                                                 </P
16916 ></LI
16917 ><LI
16918 ><P
16919 >&#13;array of string, Home page                                                                        </P
16920 ></LI
16921 ></UL
16922 ></LI
16923 ><LI
16924 ><P
16925 >&#13;                                                          <CODE
16926 CLASS="parameter"
16927 >verification_key</CODE
16928 >
16929 : string or array of string                                                     </P
16930 ><P
16931 ></P
16932 ><UL
16933 ><LI
16934 ><P
16935 >&#13;string, Reset password key                                                                        </P
16936 ></LI
16937 ><LI
16938 ><P
16939 >&#13;array of string, Reset password key                                                                       </P
16940 ></LI
16941 ></UL
16942 ></LI
16943 ><LI
16944 ><P
16945 >&#13;                                                          <CODE
16946 CLASS="parameter"
16947 >enabled</CODE
16948 >
16949 : boolean or array of boolean                                                   </P
16950 ><P
16951 ></P
16952 ><UL
16953 ><LI
16954 ><P
16955 >&#13;boolean, Has been enabled                                                                 </P
16956 ></LI
16957 ><LI
16958 ><P
16959 >&#13;array of boolean, Has been enabled                                                                        </P
16960 ></LI
16961 ></UL
16962 ></LI
16963 ><LI
16964 ><P
16965 >&#13;                                                          <CODE
16966 CLASS="parameter"
16967 >phone</CODE
16968 >
16969 : string or array of string                                                     </P
16970 ><P
16971 ></P
16972 ><UL
16973 ><LI
16974 ><P
16975 >&#13;string, Telephone number                                                                  </P
16976 ></LI
16977 ><LI
16978 ><P
16979 >&#13;array of string, Telephone number                                                                 </P
16980 ></LI
16981 ></UL
16982 ></LI
16983 ><LI
16984 ><P
16985 >&#13;                                                          <CODE
16986 CLASS="parameter"
16987 >peer_person_id</CODE
16988 >
16989 : int or array of int                                                   </P
16990 ><P
16991 ></P
16992 ><UL
16993 ><LI
16994 ><P
16995 >&#13;int, Foreign user identifier at peer                                                                      </P
16996 ></LI
16997 ><LI
16998 ><P
16999 >&#13;array of int, Foreign user identifier at peer                                                                     </P
17000 ></LI
17001 ></UL
17002 ></LI
17003 ><LI
17004 ><P
17005 >&#13;                                                          <CODE
17006 CLASS="parameter"
17007 >password</CODE
17008 >
17009 : string or array of string                                                     </P
17010 ><P
17011 ></P
17012 ><UL
17013 ><LI
17014 ><P
17015 >&#13;string, Account password in crypt() form                                                                  </P
17016 ></LI
17017 ><LI
17018 ><P
17019 >&#13;array of string, Account password in crypt() form                                                                 </P
17020 ></LI
17021 ></UL
17022 ></LI
17023 ><LI
17024 ><P
17025 >&#13;                                                          <CODE
17026 CLASS="parameter"
17027 >person_id</CODE
17028 >
17029 : int or array of int                                                   </P
17030 ><P
17031 ></P
17032 ><UL
17033 ><LI
17034 ><P
17035 >&#13;int, User identifier                                                                      </P
17036 ></LI
17037 ><LI
17038 ><P
17039 >&#13;array of int, User identifier                                                                     </P
17040 ></LI
17041 ></UL
17042 ></LI
17043 ><LI
17044 ><P
17045 >&#13;                                                          <CODE
17046 CLASS="parameter"
17047 >date_created</CODE
17048 >
17049 : int or array of int                                                   </P
17050 ><P
17051 ></P
17052 ><UL
17053 ><LI
17054 ><P
17055 >&#13;int, Date and time when account was created                                                                       </P
17056 ></LI
17057 ><LI
17058 ><P
17059 >&#13;array of int, Date and time when account was created                                                                      </P
17060 ></LI
17061 ></UL
17062 ></LI
17063 ><LI
17064 ><P
17065 >&#13;                                                          <CODE
17066 CLASS="parameter"
17067 >peer_id</CODE
17068 >
17069 : int or array of int                                                   </P
17070 ><P
17071 ></P
17072 ><UL
17073 ><LI
17074 ><P
17075 >&#13;int, Peer to which this user belongs                                                                      </P
17076 ></LI
17077 ><LI
17078 ><P
17079 >&#13;array of int, Peer to which this user belongs                                                                     </P
17080 ></LI
17081 ></UL
17082 ></LI
17083 ><LI
17084 ><P
17085 >&#13;                                                          <CODE
17086 CLASS="parameter"
17087 >verification_expires</CODE
17088 >
17089 : int or array of int                                                   </P
17090 ><P
17091 ></P
17092 ><UL
17093 ><LI
17094 ><P
17095 >&#13;int, Date and time when verification_key expires                                                                  </P
17096 ></LI
17097 ><LI
17098 ><P
17099 >&#13;array of int, Date and time when verification_key expires                                                                 </P
17100 ></LI
17101 ></UL
17102 ></LI
17103 ><LI
17104 ><P
17105 >&#13;                                                          <CODE
17106 CLASS="parameter"
17107 >email</CODE
17108 >
17109 : string or array of string                                                     </P
17110 ><P
17111 ></P
17112 ><UL
17113 ><LI
17114 ><P
17115 >&#13;string, Primary e-mail address                                                                    </P
17116 ></LI
17117 ><LI
17118 ><P
17119 >&#13;array of string, Primary e-mail address                                                                   </P
17120 ></LI
17121 ></UL
17122 ></LI
17123 ></UL
17124 ></LI
17125 ></UL
17126 ></LI
17127 ><LI
17128 ><P
17129 >&#13;                          <CODE
17130 CLASS="parameter"
17131 >subject</CODE
17132 >
17133 : string, E-mail subject                        </P
17134 ></LI
17135 ><LI
17136 ><P
17137 >&#13;                          <CODE
17138 CLASS="parameter"
17139 >body</CODE
17140 >
17141 : string, E-mail body                   </P
17142 ></LI
17143 ></UL
17144 ><P
17145 >Returns:</P
17146 ><P
17147 ></P
17148 ><UL
17149 ><LI
17150 ><P
17151 >&#13;int, 1 if successful                      </P
17152 ></LI
17153 ></UL
17154 ></DIV
17155 ><DIV
17156 CLASS="section"
17157 ><HR><H2
17158 CLASS="section"
17159 ><A
17160 NAME="RebootNode"
17161 >2.95. RebootNode</A
17162 ></H2
17163 ><P
17164 >Prototype:<A
17165 NAME="AEN5791"
17166 ></A
17167 ><BLOCKQUOTE
17168 CLASS="BLOCKQUOTE"
17169 ><P
17170 >RebootNode (auth, node_id_or_hostname)</P
17171 ></BLOCKQUOTE
17172 ></P
17173 ><P
17174 >Description:<A
17175 NAME="AEN5794"
17176 ></A
17177 ><BLOCKQUOTE
17178 CLASS="BLOCKQUOTE"
17179 ><P
17180 >Sends the specified node a specially formatted UDP packet which
17181 should cause it to reboot immediately.</P
17182 ><P
17183 >Admins can reboot any node. Techs and PIs can only reboot nodes at
17184 their site.</P
17185 ><P
17186 >Returns 1 if the packet was successfully sent (which only whether
17187 the packet was sent, not whether the reboot was successful).</P
17188 ></BLOCKQUOTE
17189 ></P
17190 ><P
17191 >Allowed Roles:<A
17192 NAME="AEN5799"
17193 ></A
17194 ><BLOCKQUOTE
17195 CLASS="BLOCKQUOTE"
17196 ><P
17197 >admin, pi, tech</P
17198 ></BLOCKQUOTE
17199 ></P
17200 ><P
17201 >Parameters:</P
17202 ><P
17203 ></P
17204 ><UL
17205 ><LI
17206 ><P
17207 >&#13;                          <CODE
17208 CLASS="parameter"
17209 >auth</CODE
17210 >
17211 : struct, API authentication structure                  </P
17212 ><P
17213 ></P
17214 ><UL
17215 ><LI
17216 ><P
17217 >&#13;                                          <CODE
17218 CLASS="parameter"
17219 >AuthMethod</CODE
17220 >
17221 : string, Authentication method to use                                  </P
17222 ></LI
17223 ></UL
17224 ></LI
17225 ><LI
17226 ><P
17227 >&#13;                          <CODE
17228 CLASS="parameter"
17229 >node_id_or_hostname</CODE
17230 >
17231 : int or string                 </P
17232 ><P
17233 ></P
17234 ><UL
17235 ><LI
17236 ><P
17237 >&#13;int, Node identifier                                      </P
17238 ></LI
17239 ><LI
17240 ><P
17241 >&#13;string, Fully qualified hostname                                  </P
17242 ></LI
17243 ></UL
17244 ></LI
17245 ></UL
17246 ><P
17247 >Returns:</P
17248 ><P
17249 ></P
17250 ><UL
17251 ><LI
17252 ><P
17253 >&#13;int, 1 if successful                      </P
17254 ></LI
17255 ></UL
17256 ></DIV
17257 ><DIV
17258 CLASS="section"
17259 ><HR><H2
17260 CLASS="section"
17261 ><A
17262 NAME="RefreshPeer"
17263 >2.96. RefreshPeer</A
17264 ></H2
17265 ><P
17266 >Prototype:<A
17267 NAME="AEN5825"
17268 ></A
17269 ><BLOCKQUOTE
17270 CLASS="BLOCKQUOTE"
17271 ><P
17272 >RefreshPeer (auth, peer_id_or_peername)</P
17273 ></BLOCKQUOTE
17274 ></P
17275 ><P
17276 >Description:<A
17277 NAME="AEN5828"
17278 ></A
17279 ><BLOCKQUOTE
17280 CLASS="BLOCKQUOTE"
17281 ><P
17282 >Fetches node and slice data from the specified peer and caches it
17283 locally; also deletes stale entries. Returns 1 if successful,
17284 faults otherwise.</P
17285 ></BLOCKQUOTE
17286 ></P
17287 ><P
17288 >Allowed Roles:<A
17289 NAME="AEN5831"
17290 ></A
17291 ><BLOCKQUOTE
17292 CLASS="BLOCKQUOTE"
17293 ><P
17294 >admin</P
17295 ></BLOCKQUOTE
17296 ></P
17297 ><P
17298 >Parameters:</P
17299 ><P
17300 ></P
17301 ><UL
17302 ><LI
17303 ><P
17304 >&#13;                          <CODE
17305 CLASS="parameter"
17306 >auth</CODE
17307 >
17308 : struct, API authentication structure                  </P
17309 ><P
17310 ></P
17311 ><UL
17312 ><LI
17313 ><P
17314 >&#13;                                          <CODE
17315 CLASS="parameter"
17316 >AuthMethod</CODE
17317 >
17318 : string, Authentication method to use                                  </P
17319 ></LI
17320 ></UL
17321 ></LI
17322 ><LI
17323 ><P
17324 >&#13;                          <CODE
17325 CLASS="parameter"
17326 >peer_id_or_peername</CODE
17327 >
17328 : int or string                 </P
17329 ><P
17330 ></P
17331 ><UL
17332 ><LI
17333 ><P
17334 >&#13;int, Peer identifier                                      </P
17335 ></LI
17336 ><LI
17337 ><P
17338 >&#13;string, Peer name                                 </P
17339 ></LI
17340 ></UL
17341 ></LI
17342 ></UL
17343 ><P
17344 >Returns:</P
17345 ><P
17346 ></P
17347 ><UL
17348 ><LI
17349 ><P
17350 >&#13;int, 1 if successful                      </P
17351 ></LI
17352 ></UL
17353 ></DIV
17354 ><DIV
17355 CLASS="section"
17356 ><HR><H2
17357 CLASS="section"
17358 ><A
17359 NAME="ResetPassword"
17360 >2.97. ResetPassword</A
17361 ></H2
17362 ><P
17363 >Prototype:<A
17364 NAME="AEN5857"
17365 ></A
17366 ><BLOCKQUOTE
17367 CLASS="BLOCKQUOTE"
17368 ><P
17369 >ResetPassword (auth, person_id_or_email, verification_key, verification_expires)</P
17370 ></BLOCKQUOTE
17371 ></P
17372 ><P
17373 >Description:<A
17374 NAME="AEN5860"
17375 ></A
17376 ><BLOCKQUOTE
17377 CLASS="BLOCKQUOTE"
17378 ><P
17379 >If verification_key is not specified, then a new verification_key
17380 will be generated and stored with the user's account. The key will
17381 be e-mailed to the user in the form of a link to a web page.</P
17382 ><P
17383 >The web page should verify the key by calling this function again
17384 and specifying verification_key. If the key matches what has been
17385 stored in the user's account, a new random password will be
17386 e-mailed to the user.</P
17387 ><P
17388 >Returns 1 if verification_key was not specified, or was specified
17389 and is valid, faults otherwise.</P
17390 ></BLOCKQUOTE
17391 ></P
17392 ><P
17393 >Allowed Roles:<A
17394 NAME="AEN5865"
17395 ></A
17396 ><BLOCKQUOTE
17397 CLASS="BLOCKQUOTE"
17398 ><P
17399 >admin</P
17400 ></BLOCKQUOTE
17401 ></P
17402 ><P
17403 >Parameters:</P
17404 ><P
17405 ></P
17406 ><UL
17407 ><LI
17408 ><P
17409 >&#13;                          <CODE
17410 CLASS="parameter"
17411 >auth</CODE
17412 >
17413 : struct, API authentication structure                  </P
17414 ><P
17415 ></P
17416 ><UL
17417 ><LI
17418 ><P
17419 >&#13;                                          <CODE
17420 CLASS="parameter"
17421 >AuthMethod</CODE
17422 >
17423 : string, Authentication method to use                                  </P
17424 ></LI
17425 ></UL
17426 ></LI
17427 ><LI
17428 ><P
17429 >&#13;                          <CODE
17430 CLASS="parameter"
17431 >person_id_or_email</CODE
17432 >
17433 : int or string                 </P
17434 ><P
17435 ></P
17436 ><UL
17437 ><LI
17438 ><P
17439 >&#13;int, User identifier                                      </P
17440 ></LI
17441 ><LI
17442 ><P
17443 >&#13;string, Primary e-mail address                                    </P
17444 ></LI
17445 ></UL
17446 ></LI
17447 ><LI
17448 ><P
17449 >&#13;                          <CODE
17450 CLASS="parameter"
17451 >verification_key</CODE
17452 >
17453 : string, Reset password key                    </P
17454 ></LI
17455 ><LI
17456 ><P
17457 >&#13;                          <CODE
17458 CLASS="parameter"
17459 >verification_expires</CODE
17460 >
17461 : int, Date and time when verification_key expires                      </P
17462 ></LI
17463 ></UL
17464 ><P
17465 >Returns:</P
17466 ><P
17467 ></P
17468 ><UL
17469 ><LI
17470 ><P
17471 >&#13;int, 1 if verification_key is valid                       </P
17472 ></LI
17473 ></UL
17474 ></DIV
17475 ><DIV
17476 CLASS="section"
17477 ><HR><H2
17478 CLASS="section"
17479 ><A
17480 NAME="SetPersonPrimarySite"
17481 >2.98. SetPersonPrimarySite</A
17482 ></H2
17483 ><P
17484 >Prototype:<A
17485 NAME="AEN5897"
17486 ></A
17487 ><BLOCKQUOTE
17488 CLASS="BLOCKQUOTE"
17489 ><P
17490 >SetPersonPrimarySite (auth, person_id_or_email, site_id_or_login_base)</P
17491 ></BLOCKQUOTE
17492 ></P
17493 ><P
17494 >Description:<A
17495 NAME="AEN5900"
17496 ></A
17497 ><BLOCKQUOTE
17498 CLASS="BLOCKQUOTE"
17499 ><P
17500 >Makes the specified site the person's primary site. The person
17501 must already be a member of the site.</P
17502 ><P
17503 >Admins may update anyone. All others may only update themselves.</P
17504 ></BLOCKQUOTE
17505 ></P
17506 ><P
17507 >Allowed Roles:<A
17508 NAME="AEN5904"
17509 ></A
17510 ><BLOCKQUOTE
17511 CLASS="BLOCKQUOTE"
17512 ><P
17513 >admin, pi, user, tech</P
17514 ></BLOCKQUOTE
17515 ></P
17516 ><P
17517 >Parameters:</P
17518 ><P
17519 ></P
17520 ><UL
17521 ><LI
17522 ><P
17523 >&#13;                          <CODE
17524 CLASS="parameter"
17525 >auth</CODE
17526 >
17527 : struct, API authentication structure                  </P
17528 ><P
17529 ></P
17530 ><UL
17531 ><LI
17532 ><P
17533 >&#13;                                          <CODE
17534 CLASS="parameter"
17535 >AuthMethod</CODE
17536 >
17537 : string, Authentication method to use                                  </P
17538 ></LI
17539 ></UL
17540 ></LI
17541 ><LI
17542 ><P
17543 >&#13;                          <CODE
17544 CLASS="parameter"
17545 >person_id_or_email</CODE
17546 >
17547 : int or string                 </P
17548 ><P
17549 ></P
17550 ><UL
17551 ><LI
17552 ><P
17553 >&#13;int, User identifier                                      </P
17554 ></LI
17555 ><LI
17556 ><P
17557 >&#13;string, Primary e-mail address                                    </P
17558 ></LI
17559 ></UL
17560 ></LI
17561 ><LI
17562 ><P
17563 >&#13;                          <CODE
17564 CLASS="parameter"
17565 >site_id_or_login_base</CODE
17566 >
17567 : int or string                 </P
17568 ><P
17569 ></P
17570 ><UL
17571 ><LI
17572 ><P
17573 >&#13;int, Site identifier                                      </P
17574 ></LI
17575 ><LI
17576 ><P
17577 >&#13;string, Site slice prefix                                 </P
17578 ></LI
17579 ></UL
17580 ></LI
17581 ></UL
17582 ><P
17583 >Returns:</P
17584 ><P
17585 ></P
17586 ><UL
17587 ><LI
17588 ><P
17589 >&#13;int, 1 if successful                      </P
17590 ></LI
17591 ></UL
17592 ></DIV
17593 ><DIV
17594 CLASS="section"
17595 ><HR><H2
17596 CLASS="section"
17597 ><A
17598 NAME="UpdateAddress"
17599 >2.99. UpdateAddress</A
17600 ></H2
17601 ><P
17602 >Prototype:<A
17603 NAME="AEN5938"
17604 ></A
17605 ><BLOCKQUOTE
17606 CLASS="BLOCKQUOTE"
17607 ><P
17608 >UpdateAddress (auth, address_id, address_fields)</P
17609 ></BLOCKQUOTE
17610 ></P
17611 ><P
17612 >Description:<A
17613 NAME="AEN5941"
17614 ></A
17615 ><BLOCKQUOTE
17616 CLASS="BLOCKQUOTE"
17617 ><P
17618 >Updates the parameters of an existing address with the values in
17619 address_fields.</P
17620 ><P
17621 >PIs may only update addresses of their own sites.</P
17622 ><P
17623 >Returns 1 if successful, faults otherwise.</P
17624 ></BLOCKQUOTE
17625 ></P
17626 ><P
17627 >Allowed Roles:<A
17628 NAME="AEN5946"
17629 ></A
17630 ><BLOCKQUOTE
17631 CLASS="BLOCKQUOTE"
17632 ><P
17633 >admin, pi</P
17634 ></BLOCKQUOTE
17635 ></P
17636 ><P
17637 >Parameters:</P
17638 ><P
17639 ></P
17640 ><UL
17641 ><LI
17642 ><P
17643 >&#13;                          <CODE
17644 CLASS="parameter"
17645 >auth</CODE
17646 >
17647 : struct, API authentication structure                  </P
17648 ><P
17649 ></P
17650 ><UL
17651 ><LI
17652 ><P
17653 >&#13;                                          <CODE
17654 CLASS="parameter"
17655 >AuthMethod</CODE
17656 >
17657 : string, Authentication method to use                                  </P
17658 ></LI
17659 ></UL
17660 ></LI
17661 ><LI
17662 ><P
17663 >&#13;                          <CODE
17664 CLASS="parameter"
17665 >address_id</CODE
17666 >
17667 : int, Address identifier                       </P
17668 ></LI
17669 ><LI
17670 ><P
17671 >&#13;                          <CODE
17672 CLASS="parameter"
17673 >address_fields</CODE
17674 >
17675 : struct                        </P
17676 ><P
17677 ></P
17678 ><UL
17679 ><LI
17680 ><P
17681 >&#13;                                          <CODE
17682 CLASS="parameter"
17683 >city</CODE
17684 >
17685 : string, City                                  </P
17686 ></LI
17687 ><LI
17688 ><P
17689 >&#13;                                          <CODE
17690 CLASS="parameter"
17691 >country</CODE
17692 >
17693 : string, Country                                       </P
17694 ></LI
17695 ><LI
17696 ><P
17697 >&#13;                                          <CODE
17698 CLASS="parameter"
17699 >line3</CODE
17700 >
17701 : string, Address line 3                                        </P
17702 ></LI
17703 ><LI
17704 ><P
17705 >&#13;                                          <CODE
17706 CLASS="parameter"
17707 >line2</CODE
17708 >
17709 : string, Address line 2                                        </P
17710 ></LI
17711 ><LI
17712 ><P
17713 >&#13;                                          <CODE
17714 CLASS="parameter"
17715 >line1</CODE
17716 >
17717 : string, Address line 1                                        </P
17718 ></LI
17719 ><LI
17720 ><P
17721 >&#13;                                          <CODE
17722 CLASS="parameter"
17723 >state</CODE
17724 >
17725 : string, State or province                                     </P
17726 ></LI
17727 ><LI
17728 ><P
17729 >&#13;                                          <CODE
17730 CLASS="parameter"
17731 >postalcode</CODE
17732 >
17733 : string, Postal code                                   </P
17734 ></LI
17735 ></UL
17736 ></LI
17737 ></UL
17738 ><P
17739 >Returns:</P
17740 ><P
17741 ></P
17742 ><UL
17743 ><LI
17744 ><P
17745 >&#13;int, 1 if successful                      </P
17746 ></LI
17747 ></UL
17748 ></DIV
17749 ><DIV
17750 CLASS="section"
17751 ><HR><H2
17752 CLASS="section"
17753 ><A
17754 NAME="UpdateAddressType"
17755 >2.100. UpdateAddressType</A
17756 ></H2
17757 ><P
17758 >Prototype:<A
17759 NAME="AEN5992"
17760 ></A
17761 ><BLOCKQUOTE
17762 CLASS="BLOCKQUOTE"
17763 ><P
17764 >UpdateAddressType (auth, address_type_id_or_name, address_type_fields)</P
17765 ></BLOCKQUOTE
17766 ></P
17767 ><P
17768 >Description:<A
17769 NAME="AEN5995"
17770 ></A
17771 ><BLOCKQUOTE
17772 CLASS="BLOCKQUOTE"
17773 ><P
17774 >Updates the parameters of an existing address type with the values
17775 in address_type_fields.</P
17776 ><P
17777 >Returns 1 if successful, faults otherwise.</P
17778 ></BLOCKQUOTE
17779 ></P
17780 ><P
17781 >Allowed Roles:<A
17782 NAME="AEN5999"
17783 ></A
17784 ><BLOCKQUOTE
17785 CLASS="BLOCKQUOTE"
17786 ><P
17787 >admin</P
17788 ></BLOCKQUOTE
17789 ></P
17790 ><P
17791 >Parameters:</P
17792 ><P
17793 ></P
17794 ><UL
17795 ><LI
17796 ><P
17797 >&#13;                          <CODE
17798 CLASS="parameter"
17799 >auth</CODE
17800 >
17801 : struct, API authentication structure                  </P
17802 ><P
17803 ></P
17804 ><UL
17805 ><LI
17806 ><P
17807 >&#13;                                          <CODE
17808 CLASS="parameter"
17809 >AuthMethod</CODE
17810 >
17811 : string, Authentication method to use                                  </P
17812 ></LI
17813 ></UL
17814 ></LI
17815 ><LI
17816 ><P
17817 >&#13;                          <CODE
17818 CLASS="parameter"
17819 >address_type_id_or_name</CODE
17820 >
17821 : int or string                 </P
17822 ><P
17823 ></P
17824 ><UL
17825 ><LI
17826 ><P
17827 >&#13;int, Address type identifier                                      </P
17828 ></LI
17829 ><LI
17830 ><P
17831 >&#13;string, Address type                                      </P
17832 ></LI
17833 ></UL
17834 ></LI
17835 ><LI
17836 ><P
17837 >&#13;                          <CODE
17838 CLASS="parameter"
17839 >address_type_fields</CODE
17840 >
17841 : struct                        </P
17842 ><P
17843 ></P
17844 ><UL
17845 ><LI
17846 ><P
17847 >&#13;                                          <CODE
17848 CLASS="parameter"
17849 >name</CODE
17850 >
17851 : string, Address type                                  </P
17852 ></LI
17853 ><LI
17854 ><P
17855 >&#13;                                          <CODE
17856 CLASS="parameter"
17857 >description</CODE
17858 >
17859 : string, Address type description                                      </P
17860 ></LI
17861 ></UL
17862 ></LI
17863 ></UL
17864 ><P
17865 >Returns:</P
17866 ><P
17867 ></P
17868 ><UL
17869 ><LI
17870 ><P
17871 >&#13;int, 1 if successful                      </P
17872 ></LI
17873 ></UL
17874 ></DIV
17875 ><DIV
17876 CLASS="section"
17877 ><HR><H2
17878 CLASS="section"
17879 ><A
17880 NAME="UpdateConfFile"
17881 >2.101. UpdateConfFile</A
17882 ></H2
17883 ><P
17884 >Prototype:<A
17885 NAME="AEN6035"
17886 ></A
17887 ><BLOCKQUOTE
17888 CLASS="BLOCKQUOTE"
17889 ><P
17890 >UpdateConfFile (auth, conf_file_id, conf_file_fields)</P
17891 ></BLOCKQUOTE
17892 ></P
17893 ><P
17894 >Description:<A
17895 NAME="AEN6038"
17896 ></A
17897 ><BLOCKQUOTE
17898 CLASS="BLOCKQUOTE"
17899 ><P
17900 >Updates a node configuration file. Only the fields specified in
17901 conf_file_fields are updated, all other fields are left untouched.</P
17902 ><P
17903 >Returns 1 if successful, faults otherwise.</P
17904 ></BLOCKQUOTE
17905 ></P
17906 ><P
17907 >Allowed Roles:<A
17908 NAME="AEN6042"
17909 ></A
17910 ><BLOCKQUOTE
17911 CLASS="BLOCKQUOTE"
17912 ><P
17913 >admin</P
17914 ></BLOCKQUOTE
17915 ></P
17916 ><P
17917 >Parameters:</P
17918 ><P
17919 ></P
17920 ><UL
17921 ><LI
17922 ><P
17923 >&#13;                          <CODE
17924 CLASS="parameter"
17925 >auth</CODE
17926 >
17927 : struct, API authentication structure                  </P
17928 ><P
17929 ></P
17930 ><UL
17931 ><LI
17932 ><P
17933 >&#13;                                          <CODE
17934 CLASS="parameter"
17935 >AuthMethod</CODE
17936 >
17937 : string, Authentication method to use                                  </P
17938 ></LI
17939 ></UL
17940 ></LI
17941 ><LI
17942 ><P
17943 >&#13;                          <CODE
17944 CLASS="parameter"
17945 >conf_file_id</CODE
17946 >
17947 : int, Configuration file identifier                    </P
17948 ></LI
17949 ><LI
17950 ><P
17951 >&#13;                          <CODE
17952 CLASS="parameter"
17953 >conf_file_fields</CODE
17954 >
17955 : struct                        </P
17956 ><P
17957 ></P
17958 ><UL
17959 ><LI
17960 ><P
17961 >&#13;                                          <CODE
17962 CLASS="parameter"
17963 >file_owner</CODE
17964 >
17965 : string, chown(1) owner                                        </P
17966 ></LI
17967 ><LI
17968 ><P
17969 >&#13;                                          <CODE
17970 CLASS="parameter"
17971 >postinstall_cmd</CODE
17972 >
17973 : string, Shell command to execute after installing                                     </P
17974 ></LI
17975 ><LI
17976 ><P
17977 >&#13;                                          <CODE
17978 CLASS="parameter"
17979 >error_cmd</CODE
17980 >
17981 : string, Shell command to execute if any error occurs                                  </P
17982 ></LI
17983 ><LI
17984 ><P
17985 >&#13;                                          <CODE
17986 CLASS="parameter"
17987 >preinstall_cmd</CODE
17988 >
17989 : string, Shell command to execute prior to installing                                  </P
17990 ></LI
17991 ><LI
17992 ><P
17993 >&#13;                                          <CODE
17994 CLASS="parameter"
17995 >dest</CODE
17996 >
17997 : string, Absolute path where file should be installed                                  </P
17998 ></LI
17999 ><LI
18000 ><P
18001 >&#13;                                          <CODE
18002 CLASS="parameter"
18003 >ignore_cmd_errors</CODE
18004 >
18005 : boolean, Install file anyway even if an error occurs                                  </P
18006 ></LI
18007 ><LI
18008 ><P
18009 >&#13;                                          <CODE
18010 CLASS="parameter"
18011 >enabled</CODE
18012 >
18013 : boolean, Configuration file is active                                 </P
18014 ></LI
18015 ><LI
18016 ><P
18017 >&#13;                                          <CODE
18018 CLASS="parameter"
18019 >file_permissions</CODE
18020 >
18021 : string, chmod(1) permissions                                  </P
18022 ></LI
18023 ><LI
18024 ><P
18025 >&#13;                                          <CODE
18026 CLASS="parameter"
18027 >source</CODE
18028 >
18029 : string, Relative path on the boot server where file can be downloaded                                 </P
18030 ></LI
18031 ><LI
18032 ><P
18033 >&#13;                                          <CODE
18034 CLASS="parameter"
18035 >always_update</CODE
18036 >
18037 : boolean, Always attempt to install file even if unchanged                                     </P
18038 ></LI
18039 ><LI
18040 ><P
18041 >&#13;                                          <CODE
18042 CLASS="parameter"
18043 >file_group</CODE
18044 >
18045 : string, chgrp(1) owner                                        </P
18046 ></LI
18047 ></UL
18048 ></LI
18049 ></UL
18050 ><P
18051 >Returns:</P
18052 ><P
18053 ></P
18054 ><UL
18055 ><LI
18056 ><P
18057 >&#13;int, 1 if successful                      </P
18058 ></LI
18059 ></UL
18060 ></DIV
18061 ><DIV
18062 CLASS="section"
18063 ><HR><H2
18064 CLASS="section"
18065 ><A
18066 NAME="UpdateKey"
18067 >2.102. UpdateKey</A
18068 ></H2
18069 ><P
18070 >Prototype:<A
18071 NAME="AEN6100"
18072 ></A
18073 ><BLOCKQUOTE
18074 CLASS="BLOCKQUOTE"
18075 ><P
18076 >UpdateKey (auth, key_id, key_fields)</P
18077 ></BLOCKQUOTE
18078 ></P
18079 ><P
18080 >Description:<A
18081 NAME="AEN6103"
18082 ></A
18083 ><BLOCKQUOTE
18084 CLASS="BLOCKQUOTE"
18085 ><P
18086 >Updates the parameters of an existing key with the values in
18087 key_fields.</P
18088 ><P
18089 >Non-admins may only update their own keys.</P
18090 ><P
18091 >Returns 1 if successful, faults otherwise.</P
18092 ></BLOCKQUOTE
18093 ></P
18094 ><P
18095 >Allowed Roles:<A
18096 NAME="AEN6108"
18097 ></A
18098 ><BLOCKQUOTE
18099 CLASS="BLOCKQUOTE"
18100 ><P
18101 >admin, pi, tech, user</P
18102 ></BLOCKQUOTE
18103 ></P
18104 ><P
18105 >Parameters:</P
18106 ><P
18107 ></P
18108 ><UL
18109 ><LI
18110 ><P
18111 >&#13;                          <CODE
18112 CLASS="parameter"
18113 >auth</CODE
18114 >
18115 : struct, API authentication structure                  </P
18116 ><P
18117 ></P
18118 ><UL
18119 ><LI
18120 ><P
18121 >&#13;                                          <CODE
18122 CLASS="parameter"
18123 >AuthMethod</CODE
18124 >
18125 : string, Authentication method to use                                  </P
18126 ></LI
18127 ></UL
18128 ></LI
18129 ><LI
18130 ><P
18131 >&#13;                          <CODE
18132 CLASS="parameter"
18133 >key_id</CODE
18134 >
18135 : int, Key identifier                   </P
18136 ></LI
18137 ><LI
18138 ><P
18139 >&#13;                          <CODE
18140 CLASS="parameter"
18141 >key_fields</CODE
18142 >
18143 : struct                        </P
18144 ><P
18145 ></P
18146 ><UL
18147 ><LI
18148 ><P
18149 >&#13;                                          <CODE
18150 CLASS="parameter"
18151 >key_type</CODE
18152 >
18153 : string, Key type                                      </P
18154 ></LI
18155 ><LI
18156 ><P
18157 >&#13;                                          <CODE
18158 CLASS="parameter"
18159 >key</CODE
18160 >
18161 : string, Key value                                     </P
18162 ></LI
18163 ></UL
18164 ></LI
18165 ></UL
18166 ><P
18167 >Returns:</P
18168 ><P
18169 ></P
18170 ><UL
18171 ><LI
18172 ><P
18173 >&#13;int, 1 if successful                      </P
18174 ></LI
18175 ></UL
18176 ></DIV
18177 ><DIV
18178 CLASS="section"
18179 ><HR><H2
18180 CLASS="section"
18181 ><A
18182 NAME="UpdateMessage"
18183 >2.103. UpdateMessage</A
18184 ></H2
18185 ><P
18186 >Prototype:<A
18187 NAME="AEN6139"
18188 ></A
18189 ><BLOCKQUOTE
18190 CLASS="BLOCKQUOTE"
18191 ><P
18192 >UpdateMessage (auth, message_id, message_fields)</P
18193 ></BLOCKQUOTE
18194 ></P
18195 ><P
18196 >Description:<A
18197 NAME="AEN6142"
18198 ></A
18199 ><BLOCKQUOTE
18200 CLASS="BLOCKQUOTE"
18201 ><P
18202 >Updates the parameters of an existing message template with the
18203 values in message_fields.</P
18204 ><P
18205 >Returns 1 if successful, faults otherwise.</P
18206 ></BLOCKQUOTE
18207 ></P
18208 ><P
18209 >Allowed Roles:<A
18210 NAME="AEN6146"
18211 ></A
18212 ><BLOCKQUOTE
18213 CLASS="BLOCKQUOTE"
18214 ><P
18215 >admin</P
18216 ></BLOCKQUOTE
18217 ></P
18218 ><P
18219 >Parameters:</P
18220 ><P
18221 ></P
18222 ><UL
18223 ><LI
18224 ><P
18225 >&#13;                          <CODE
18226 CLASS="parameter"
18227 >auth</CODE
18228 >
18229 : struct, API authentication structure                  </P
18230 ><P
18231 ></P
18232 ><UL
18233 ><LI
18234 ><P
18235 >&#13;                                          <CODE
18236 CLASS="parameter"
18237 >AuthMethod</CODE
18238 >
18239 : string, Authentication method to use                                  </P
18240 ></LI
18241 ></UL
18242 ></LI
18243 ><LI
18244 ><P
18245 >&#13;                          <CODE
18246 CLASS="parameter"
18247 >message_id</CODE
18248 >
18249 : string, Message identifier                    </P
18250 ></LI
18251 ><LI
18252 ><P
18253 >&#13;                          <CODE
18254 CLASS="parameter"
18255 >message_fields</CODE
18256 >
18257 : struct                        </P
18258 ><P
18259 ></P
18260 ><UL
18261 ><LI
18262 ><P
18263 >&#13;                                          <CODE
18264 CLASS="parameter"
18265 >enabled</CODE
18266 >
18267 : boolean, Message is enabled                                   </P
18268 ></LI
18269 ><LI
18270 ><P
18271 >&#13;                                          <CODE
18272 CLASS="parameter"
18273 >template</CODE
18274 >
18275 : string, Message template                                      </P
18276 ></LI
18277 ></UL
18278 ></LI
18279 ></UL
18280 ><P
18281 >Returns:</P
18282 ><P
18283 ></P
18284 ><UL
18285 ><LI
18286 ><P
18287 >&#13;int, 1 if successful                      </P
18288 ></LI
18289 ></UL
18290 ></DIV
18291 ><DIV
18292 CLASS="section"
18293 ><HR><H2
18294 CLASS="section"
18295 ><A
18296 NAME="UpdateNodeGroup"
18297 >2.104. UpdateNodeGroup</A
18298 ></H2
18299 ><P
18300 >Prototype:<A
18301 NAME="AEN6177"
18302 ></A
18303 ><BLOCKQUOTE
18304 CLASS="BLOCKQUOTE"
18305 ><P
18306 >UpdateNodeGroup (auth, nodegroup_id_or_name, nodegroup_fields)</P
18307 ></BLOCKQUOTE
18308 ></P
18309 ><P
18310 >Description:<A
18311 NAME="AEN6180"
18312 ></A
18313 ><BLOCKQUOTE
18314 CLASS="BLOCKQUOTE"
18315 ><P
18316 >Updates a custom node group.</P
18317 ><P
18318 >Returns 1 if successful, faults otherwise.</P
18319 ></BLOCKQUOTE
18320 ></P
18321 ><P
18322 >Allowed Roles:<A
18323 NAME="AEN6184"
18324 ></A
18325 ><BLOCKQUOTE
18326 CLASS="BLOCKQUOTE"
18327 ><P
18328 >admin</P
18329 ></BLOCKQUOTE
18330 ></P
18331 ><P
18332 >Parameters:</P
18333 ><P
18334 ></P
18335 ><UL
18336 ><LI
18337 ><P
18338 >&#13;                          <CODE
18339 CLASS="parameter"
18340 >auth</CODE
18341 >
18342 : struct, API authentication structure                  </P
18343 ><P
18344 ></P
18345 ><UL
18346 ><LI
18347 ><P
18348 >&#13;                                          <CODE
18349 CLASS="parameter"
18350 >AuthMethod</CODE
18351 >
18352 : string, Authentication method to use                                  </P
18353 ></LI
18354 ></UL
18355 ></LI
18356 ><LI
18357 ><P
18358 >&#13;                          <CODE
18359 CLASS="parameter"
18360 >nodegroup_id_or_name</CODE
18361 >
18362 : int or string                 </P
18363 ><P
18364 ></P
18365 ><UL
18366 ><LI
18367 ><P
18368 >&#13;int, Node group identifier                                        </P
18369 ></LI
18370 ><LI
18371 ><P
18372 >&#13;string, Node group name                                   </P
18373 ></LI
18374 ></UL
18375 ></LI
18376 ><LI
18377 ><P
18378 >&#13;                          <CODE
18379 CLASS="parameter"
18380 >nodegroup_fields</CODE
18381 >
18382 : struct                        </P
18383 ><P
18384 ></P
18385 ><UL
18386 ><LI
18387 ><P
18388 >&#13;                                          <CODE
18389 CLASS="parameter"
18390 >name</CODE
18391 >
18392 : string, Node group name                                       </P
18393 ></LI
18394 ><LI
18395 ><P
18396 >&#13;                                          <CODE
18397 CLASS="parameter"
18398 >description</CODE
18399 >
18400 : string, Node group description                                        </P
18401 ></LI
18402 ></UL
18403 ></LI
18404 ></UL
18405 ><P
18406 >Returns:</P
18407 ><P
18408 ></P
18409 ><UL
18410 ><LI
18411 ><P
18412 >&#13;int, 1 if successful                      </P
18413 ></LI
18414 ></UL
18415 ></DIV
18416 ><DIV
18417 CLASS="section"
18418 ><HR><H2
18419 CLASS="section"
18420 ><A
18421 NAME="UpdateNodeNetwork"
18422 >2.105. UpdateNodeNetwork</A
18423 ></H2
18424 ><P
18425 >Prototype:<A
18426 NAME="AEN6220"
18427 ></A
18428 ><BLOCKQUOTE
18429 CLASS="BLOCKQUOTE"
18430 ><P
18431 >UpdateNodeNetwork (auth, nodenetwork_id, nodenetwork_fields)</P
18432 ></BLOCKQUOTE
18433 ></P
18434 ><P
18435 >Description:<A
18436 NAME="AEN6223"
18437 ></A
18438 ><BLOCKQUOTE
18439 CLASS="BLOCKQUOTE"
18440 ><P
18441 >Updates an existing node network. Any values specified in
18442 nodenetwork_fields are used, otherwise defaults are
18443 used. Acceptable values for method are dhcp and static. If type is
18444 static, then ip, gateway, network, broadcast, netmask, and dns1
18445 must all be specified in nodenetwork_fields. If type is dhcp,
18446 these parameters, even if specified, are ignored.</P
18447 ><P
18448 >PIs and techs may only update networks associated with their own
18449 nodes. Admins may update any node network.</P
18450 ><P
18451 >Returns 1 if successful, faults otherwise.</P
18452 ></BLOCKQUOTE
18453 ></P
18454 ><P
18455 >Allowed Roles:<A
18456 NAME="AEN6228"
18457 ></A
18458 ><BLOCKQUOTE
18459 CLASS="BLOCKQUOTE"
18460 ><P
18461 >admin, pi, tech</P
18462 ></BLOCKQUOTE
18463 ></P
18464 ><P
18465 >Parameters:</P
18466 ><P
18467 ></P
18468 ><UL
18469 ><LI
18470 ><P
18471 >&#13;                          <CODE
18472 CLASS="parameter"
18473 >auth</CODE
18474 >
18475 : struct, API authentication structure                  </P
18476 ><P
18477 ></P
18478 ><UL
18479 ><LI
18480 ><P
18481 >&#13;                                          <CODE
18482 CLASS="parameter"
18483 >AuthMethod</CODE
18484 >
18485 : string, Authentication method to use                                  </P
18486 ></LI
18487 ></UL
18488 ></LI
18489 ><LI
18490 ><P
18491 >&#13;                          <CODE
18492 CLASS="parameter"
18493 >nodenetwork_id</CODE
18494 >
18495 : int, Node interface identifier                        </P
18496 ></LI
18497 ><LI
18498 ><P
18499 >&#13;                          <CODE
18500 CLASS="parameter"
18501 >nodenetwork_fields</CODE
18502 >
18503 : struct                        </P
18504 ><P
18505 ></P
18506 ><UL
18507 ><LI
18508 ><P
18509 >&#13;                                          <CODE
18510 CLASS="parameter"
18511 >network</CODE
18512 >
18513 : string, Subnet address                                        </P
18514 ></LI
18515 ><LI
18516 ><P
18517 >&#13;                                          <CODE
18518 CLASS="parameter"
18519 >is_primary</CODE
18520 >
18521 : boolean, Is the primary interface for this node                                       </P
18522 ></LI
18523 ><LI
18524 ><P
18525 >&#13;                                          <CODE
18526 CLASS="parameter"
18527 >dns1</CODE
18528 >
18529 : string, IP address of primary DNS server                                      </P
18530 ></LI
18531 ><LI
18532 ><P
18533 >&#13;                                          <CODE
18534 CLASS="parameter"
18535 >hostname</CODE
18536 >
18537 : string, (Optional) Hostname                                   </P
18538 ></LI
18539 ><LI
18540 ><P
18541 >&#13;                                          <CODE
18542 CLASS="parameter"
18543 >mac</CODE
18544 >
18545 : string, MAC address                                   </P
18546 ></LI
18547 ><LI
18548 ><P
18549 >&#13;                                          <CODE
18550 CLASS="parameter"
18551 >bwlimit</CODE
18552 >
18553 : int, Bandwidth limit                                  </P
18554 ></LI
18555 ><LI
18556 ><P
18557 >&#13;                                          <CODE
18558 CLASS="parameter"
18559 >broadcast</CODE
18560 >
18561 : string, Network broadcast address                                     </P
18562 ></LI
18563 ><LI
18564 ><P
18565 >&#13;                                          <CODE
18566 CLASS="parameter"
18567 >method</CODE
18568 >
18569 : string, Addressing method (e.g., 'static' or 'dhcp')                                  </P
18570 ></LI
18571 ><LI
18572 ><P
18573 >&#13;                                          <CODE
18574 CLASS="parameter"
18575 >netmask</CODE
18576 >
18577 : string, Subnet mask                                   </P
18578 ></LI
18579 ><LI
18580 ><P
18581 >&#13;                                          <CODE
18582 CLASS="parameter"
18583 >dns2</CODE
18584 >
18585 : string, IP address of secondary DNS server                                    </P
18586 ></LI
18587 ><LI
18588 ><P
18589 >&#13;                                          <CODE
18590 CLASS="parameter"
18591 >ip</CODE
18592 >
18593 : string, IP address                                    </P
18594 ></LI
18595 ><LI
18596 ><P
18597 >&#13;                                          <CODE
18598 CLASS="parameter"
18599 >type</CODE
18600 >
18601 : string, Address type (e.g., 'ipv4')                                   </P
18602 ></LI
18603 ><LI
18604 ><P
18605 >&#13;                                          <CODE
18606 CLASS="parameter"
18607 >gateway</CODE
18608 >
18609 : string, IP address of primary gateway                                 </P
18610 ></LI
18611 ></UL
18612 ></LI
18613 ></UL
18614 ><P
18615 >Returns:</P
18616 ><P
18617 ></P
18618 ><UL
18619 ><LI
18620 ><P
18621 >&#13;int, 1 if successful                      </P
18622 ></LI
18623 ></UL
18624 ></DIV
18625 ><DIV
18626 CLASS="section"
18627 ><HR><H2
18628 CLASS="section"
18629 ><A
18630 NAME="UpdateNode"
18631 >2.106. UpdateNode</A
18632 ></H2
18633 ><P
18634 >Prototype:<A
18635 NAME="AEN6292"
18636 ></A
18637 ><BLOCKQUOTE
18638 CLASS="BLOCKQUOTE"
18639 ><P
18640 >UpdateNode (auth, node_id_or_hostname, node_fields)</P
18641 ></BLOCKQUOTE
18642 ></P
18643 ><P
18644 >Description:<A
18645 NAME="AEN6295"
18646 ></A
18647 ><BLOCKQUOTE
18648 CLASS="BLOCKQUOTE"
18649 ><P
18650 >Updates a node. Only the fields specified in node_fields are
18651 updated, all other fields are left untouched.</P
18652 ><P
18653 >PIs and techs can update only the nodes at their sites. Only
18654 admins can update the key, session, and boot_nonce fields.</P
18655 ><P
18656 >Returns 1 if successful, faults otherwise.</P
18657 ></BLOCKQUOTE
18658 ></P
18659 ><P
18660 >Allowed Roles:<A
18661 NAME="AEN6300"
18662 ></A
18663 ><BLOCKQUOTE
18664 CLASS="BLOCKQUOTE"
18665 ><P
18666 >admin, pi, tech</P
18667 ></BLOCKQUOTE
18668 ></P
18669 ><P
18670 >Parameters:</P
18671 ><P
18672 ></P
18673 ><UL
18674 ><LI
18675 ><P
18676 >&#13;                          <CODE
18677 CLASS="parameter"
18678 >auth</CODE
18679 >
18680 : struct, API authentication structure                  </P
18681 ><P
18682 ></P
18683 ><UL
18684 ><LI
18685 ><P
18686 >&#13;                                          <CODE
18687 CLASS="parameter"
18688 >AuthMethod</CODE
18689 >
18690 : string, Authentication method to use                                  </P
18691 ></LI
18692 ></UL
18693 ></LI
18694 ><LI
18695 ><P
18696 >&#13;                          <CODE
18697 CLASS="parameter"
18698 >node_id_or_hostname</CODE
18699 >
18700 : int or string                 </P
18701 ><P
18702 ></P
18703 ><UL
18704 ><LI
18705 ><P
18706 >&#13;int, Node identifier                                      </P
18707 ></LI
18708 ><LI
18709 ><P
18710 >&#13;string, Fully qualified hostname                                  </P
18711 ></LI
18712 ></UL
18713 ></LI
18714 ><LI
18715 ><P
18716 >&#13;                          <CODE
18717 CLASS="parameter"
18718 >node_fields</CODE
18719 >
18720 : struct                        </P
18721 ><P
18722 ></P
18723 ><UL
18724 ><LI
18725 ><P
18726 >&#13;                                          <CODE
18727 CLASS="parameter"
18728 >version</CODE
18729 >
18730 : string, Apparent Boot CD version                                      </P
18731 ></LI
18732 ><LI
18733 ><P
18734 >&#13;                                          <CODE
18735 CLASS="parameter"
18736 >boot_state</CODE
18737 >
18738 : string, Boot state                                    </P
18739 ></LI
18740 ><LI
18741 ><P
18742 >&#13;                                          <CODE
18743 CLASS="parameter"
18744 >hostname</CODE
18745 >
18746 : string, Fully qualified hostname                                      </P
18747 ></LI
18748 ><LI
18749 ><P
18750 >&#13;                                          <CODE
18751 CLASS="parameter"
18752 >boot_nonce</CODE
18753 >
18754 : string, (Admin only) Random value generated by the node at last boot                                  </P
18755 ></LI
18756 ><LI
18757 ><P
18758 >&#13;                                          <CODE
18759 CLASS="parameter"
18760 >session</CODE
18761 >
18762 : string, (Admin only) Node session value                                       </P
18763 ></LI
18764 ><LI
18765 ><P
18766 >&#13;                                          <CODE
18767 CLASS="parameter"
18768 >key</CODE
18769 >
18770 : string, (Admin only) Node key                                 </P
18771 ></LI
18772 ><LI
18773 ><P
18774 >&#13;                                          <CODE
18775 CLASS="parameter"
18776 >model</CODE
18777 >
18778 : string, Make and model of the actual machine                                  </P
18779 ></LI
18780 ></UL
18781 ></LI
18782 ></UL
18783 ><P
18784 >Returns:</P
18785 ><P
18786 ></P
18787 ><UL
18788 ><LI
18789 ><P
18790 >&#13;int, 1 if successful                      </P
18791 ></LI
18792 ></UL
18793 ></DIV
18794 ><DIV
18795 CLASS="section"
18796 ><HR><H2
18797 CLASS="section"
18798 ><A
18799 NAME="UpdatePCU"
18800 >2.107. UpdatePCU</A
18801 ></H2
18802 ><P
18803 >Prototype:<A
18804 NAME="AEN6351"
18805 ></A
18806 ><BLOCKQUOTE
18807 CLASS="BLOCKQUOTE"
18808 ><P
18809 >UpdatePCU (auth, pcu_id, pcu_fields)</P
18810 ></BLOCKQUOTE
18811 ></P
18812 ><P
18813 >Description:<A
18814 NAME="AEN6354"
18815 ></A
18816 ><BLOCKQUOTE
18817 CLASS="BLOCKQUOTE"
18818 ><P
18819 >Updates the parameters of an existing PCU with the values in
18820 pcu_fields.</P
18821 ><P
18822 >Non-admins may only update PCUs at their sites.</P
18823 ><P
18824 >Returns 1 if successful, faults otherwise.</P
18825 ></BLOCKQUOTE
18826 ></P
18827 ><P
18828 >Allowed Roles:<A
18829 NAME="AEN6359"
18830 ></A
18831 ><BLOCKQUOTE
18832 CLASS="BLOCKQUOTE"
18833 ><P
18834 >admin, pi, tech</P
18835 ></BLOCKQUOTE
18836 ></P
18837 ><P
18838 >Parameters:</P
18839 ><P
18840 ></P
18841 ><UL
18842 ><LI
18843 ><P
18844 >&#13;                          <CODE
18845 CLASS="parameter"
18846 >auth</CODE
18847 >
18848 : struct, API authentication structure                  </P
18849 ><P
18850 ></P
18851 ><UL
18852 ><LI
18853 ><P
18854 >&#13;                                          <CODE
18855 CLASS="parameter"
18856 >AuthMethod</CODE
18857 >
18858 : string, Authentication method to use                                  </P
18859 ></LI
18860 ></UL
18861 ></LI
18862 ><LI
18863 ><P
18864 >&#13;                          <CODE
18865 CLASS="parameter"
18866 >pcu_id</CODE
18867 >
18868 : int, PCU identifier                   </P
18869 ></LI
18870 ><LI
18871 ><P
18872 >&#13;                          <CODE
18873 CLASS="parameter"
18874 >pcu_fields</CODE
18875 >
18876 : struct                        </P
18877 ><P
18878 ></P
18879 ><UL
18880 ><LI
18881 ><P
18882 >&#13;                                          <CODE
18883 CLASS="parameter"
18884 >username</CODE
18885 >
18886 : string, PCU username                                  </P
18887 ></LI
18888 ><LI
18889 ><P
18890 >&#13;                                          <CODE
18891 CLASS="parameter"
18892 >protocol</CODE
18893 >
18894 : string, PCU protocol, e.g. ssh, https, telnet                                 </P
18895 ></LI
18896 ><LI
18897 ><P
18898 >&#13;                                          <CODE
18899 CLASS="parameter"
18900 >node_ids</CODE
18901 >
18902 : array, List of nodes that this PCU controls                                   </P
18903 ><P
18904 ></P
18905 ><UL
18906 ><LI
18907 ><P
18908 >&#13;int                                                       </P
18909 ></LI
18910 ></UL
18911 ></LI
18912 ><LI
18913 ><P
18914 >&#13;                                          <CODE
18915 CLASS="parameter"
18916 >ip</CODE
18917 >
18918 : string, PCU IP address                                        </P
18919 ></LI
18920 ><LI
18921 ><P
18922 >&#13;                                          <CODE
18923 CLASS="parameter"
18924 >notes</CODE
18925 >
18926 : string, Miscellaneous notes                                   </P
18927 ></LI
18928 ><LI
18929 ><P
18930 >&#13;                                          <CODE
18931 CLASS="parameter"
18932 >hostname</CODE
18933 >
18934 : string, PCU hostname                                  </P
18935 ></LI
18936 ><LI
18937 ><P
18938 >&#13;                                          <CODE
18939 CLASS="parameter"
18940 >model</CODE
18941 >
18942 : string, PCU model string                                      </P
18943 ></LI
18944 ><LI
18945 ><P
18946 >&#13;                                          <CODE
18947 CLASS="parameter"
18948 >password</CODE
18949 >
18950 : string, PCU username                                  </P
18951 ></LI
18952 ><LI
18953 ><P
18954 >&#13;                                          <CODE
18955 CLASS="parameter"
18956 >ports</CODE
18957 >
18958 : array, List of the port numbers that each node is connected to                                        </P
18959 ><P
18960 ></P
18961 ><UL
18962 ><LI
18963 ><P
18964 >&#13;int                                                       </P
18965 ></LI
18966 ></UL
18967 ></LI
18968 ></UL
18969 ></LI
18970 ></UL
18971 ><P
18972 >Returns:</P
18973 ><P
18974 ></P
18975 ><UL
18976 ><LI
18977 ><P
18978 >&#13;int, 1 if successful                      </P
18979 ></LI
18980 ></UL
18981 ></DIV
18982 ><DIV
18983 CLASS="section"
18984 ><HR><H2
18985 CLASS="section"
18986 ><A
18987 NAME="UpdatePeer"
18988 >2.108. UpdatePeer</A
18989 ></H2
18990 ><P
18991 >Prototype:<A
18992 NAME="AEN6417"
18993 ></A
18994 ><BLOCKQUOTE
18995 CLASS="BLOCKQUOTE"
18996 ><P
18997 >UpdatePeer (auth, peer_id_or_name, peer_fields)</P
18998 ></BLOCKQUOTE
18999 ></P
19000 ><P
19001 >Description:<A
19002 NAME="AEN6420"
19003 ></A
19004 ><BLOCKQUOTE
19005 CLASS="BLOCKQUOTE"
19006 ><P
19007 >Updates a peer. Only the fields specified in peer_fields are
19008 updated, all other fields are left untouched.</P
19009 ><P
19010 >Returns 1 if successful, faults otherwise.</P
19011 ></BLOCKQUOTE
19012 ></P
19013 ><P
19014 >Allowed Roles:<A
19015 NAME="AEN6424"
19016 ></A
19017 ><BLOCKQUOTE
19018 CLASS="BLOCKQUOTE"
19019 ><P
19020 >admin</P
19021 ></BLOCKQUOTE
19022 ></P
19023 ><P
19024 >Parameters:</P
19025 ><P
19026 ></P
19027 ><UL
19028 ><LI
19029 ><P
19030 >&#13;                          <CODE
19031 CLASS="parameter"
19032 >auth</CODE
19033 >
19034 : struct, API authentication structure                  </P
19035 ><P
19036 ></P
19037 ><UL
19038 ><LI
19039 ><P
19040 >&#13;                                          <CODE
19041 CLASS="parameter"
19042 >AuthMethod</CODE
19043 >
19044 : string, Authentication method to use                                  </P
19045 ></LI
19046 ></UL
19047 ></LI
19048 ><LI
19049 ><P
19050 >&#13;                          <CODE
19051 CLASS="parameter"
19052 >peer_id_or_name</CODE
19053 >
19054 : int or string                 </P
19055 ><P
19056 ></P
19057 ><UL
19058 ><LI
19059 ><P
19060 >&#13;int, Peer identifier                                      </P
19061 ></LI
19062 ><LI
19063 ><P
19064 >&#13;string, Peer name                                 </P
19065 ></LI
19066 ></UL
19067 ></LI
19068 ><LI
19069 ><P
19070 >&#13;                          <CODE
19071 CLASS="parameter"
19072 >peer_fields</CODE
19073 >
19074 : struct                        </P
19075 ><P
19076 ></P
19077 ><UL
19078 ><LI
19079 ><P
19080 >&#13;                                          <CODE
19081 CLASS="parameter"
19082 >key</CODE
19083 >
19084 : string, Peer GPG public key                                   </P
19085 ></LI
19086 ><LI
19087 ><P
19088 >&#13;                                          <CODE
19089 CLASS="parameter"
19090 >cacert</CODE
19091 >
19092 : string, Peer SSL public certificate                                   </P
19093 ></LI
19094 ><LI
19095 ><P
19096 >&#13;                                          <CODE
19097 CLASS="parameter"
19098 >peername</CODE
19099 >
19100 : string, Peer name                                     </P
19101 ></LI
19102 ><LI
19103 ><P
19104 >&#13;                                          <CODE
19105 CLASS="parameter"
19106 >peer_url</CODE
19107 >
19108 : string, Peer API URL                                  </P
19109 ></LI
19110 ></UL
19111 ></LI
19112 ></UL
19113 ><P
19114 >Returns:</P
19115 ><P
19116 ></P
19117 ><UL
19118 ><LI
19119 ><P
19120 >&#13;int, 1 if successful                      </P
19121 ></LI
19122 ></UL
19123 ></DIV
19124 ><DIV
19125 CLASS="section"
19126 ><HR><H2
19127 CLASS="section"
19128 ><A
19129 NAME="UpdatePerson"
19130 >2.109. UpdatePerson</A
19131 ></H2
19132 ><P
19133 >Prototype:<A
19134 NAME="AEN6466"
19135 ></A
19136 ><BLOCKQUOTE
19137 CLASS="BLOCKQUOTE"
19138 ><P
19139 >UpdatePerson (auth, person_id_or_email, person_fields)</P
19140 ></BLOCKQUOTE
19141 ></P
19142 ><P
19143 >Description:<A
19144 NAME="AEN6469"
19145 ></A
19146 ><BLOCKQUOTE
19147 CLASS="BLOCKQUOTE"
19148 ><P
19149 >Updates a person. Only the fields specified in person_fields are
19150 updated, all other fields are left untouched.</P
19151 ><P
19152 >Users and techs can only update themselves. PIs can only update
19153 themselves and other non-PIs at their sites.</P
19154 ><P
19155 >Returns 1 if successful, faults otherwise.</P
19156 ></BLOCKQUOTE
19157 ></P
19158 ><P
19159 >Allowed Roles:<A
19160 NAME="AEN6474"
19161 ></A
19162 ><BLOCKQUOTE
19163 CLASS="BLOCKQUOTE"
19164 ><P
19165 >admin, pi, user, tech</P
19166 ></BLOCKQUOTE
19167 ></P
19168 ><P
19169 >Parameters:</P
19170 ><P
19171 ></P
19172 ><UL
19173 ><LI
19174 ><P
19175 >&#13;                          <CODE
19176 CLASS="parameter"
19177 >auth</CODE
19178 >
19179 : struct, API authentication structure                  </P
19180 ><P
19181 ></P
19182 ><UL
19183 ><LI
19184 ><P
19185 >&#13;                                          <CODE
19186 CLASS="parameter"
19187 >AuthMethod</CODE
19188 >
19189 : string, Authentication method to use                                  </P
19190 ></LI
19191 ></UL
19192 ></LI
19193 ><LI
19194 ><P
19195 >&#13;                          <CODE
19196 CLASS="parameter"
19197 >person_id_or_email</CODE
19198 >
19199 : int or string                 </P
19200 ><P
19201 ></P
19202 ><UL
19203 ><LI
19204 ><P
19205 >&#13;int, User identifier                                      </P
19206 ></LI
19207 ><LI
19208 ><P
19209 >&#13;string, Primary e-mail address                                    </P
19210 ></LI
19211 ></UL
19212 ></LI
19213 ><LI
19214 ><P
19215 >&#13;                          <CODE
19216 CLASS="parameter"
19217 >person_fields</CODE
19218 >
19219 : struct                        </P
19220 ><P
19221 ></P
19222 ><UL
19223 ><LI
19224 ><P
19225 >&#13;                                          <CODE
19226 CLASS="parameter"
19227 >bio</CODE
19228 >
19229 : string, Biography                                     </P
19230 ></LI
19231 ><LI
19232 ><P
19233 >&#13;                                          <CODE
19234 CLASS="parameter"
19235 >first_name</CODE
19236 >
19237 : string, Given name                                    </P
19238 ></LI
19239 ><LI
19240 ><P
19241 >&#13;                                          <CODE
19242 CLASS="parameter"
19243 >last_name</CODE
19244 >
19245 : string, Surname                                       </P
19246 ></LI
19247 ><LI
19248 ><P
19249 >&#13;                                          <CODE
19250 CLASS="parameter"
19251 >title</CODE
19252 >
19253 : string, Title                                 </P
19254 ></LI
19255 ><LI
19256 ><P
19257 >&#13;                                          <CODE
19258 CLASS="parameter"
19259 >url</CODE
19260 >
19261 : string, Home page                                     </P
19262 ></LI
19263 ><LI
19264 ><P
19265 >&#13;                                          <CODE
19266 CLASS="parameter"
19267 >enabled</CODE
19268 >
19269 : boolean, Has been enabled                                     </P
19270 ></LI
19271 ><LI
19272 ><P
19273 >&#13;                                          <CODE
19274 CLASS="parameter"
19275 >phone</CODE
19276 >
19277 : string, Telephone number                                      </P
19278 ></LI
19279 ><LI
19280 ><P
19281 >&#13;                                          <CODE
19282 CLASS="parameter"
19283 >password</CODE
19284 >
19285 : string, Account password in crypt() form                                      </P
19286 ></LI
19287 ><LI
19288 ><P
19289 >&#13;                                          <CODE
19290 CLASS="parameter"
19291 >email</CODE
19292 >
19293 : string, Primary e-mail address                                        </P
19294 ></LI
19295 ></UL
19296 ></LI
19297 ></UL
19298 ><P
19299 >Returns:</P
19300 ><P
19301 ></P
19302 ><UL
19303 ><LI
19304 ><P
19305 >&#13;int, 1 if successful                      </P
19306 ></LI
19307 ></UL
19308 ></DIV
19309 ><DIV
19310 CLASS="section"
19311 ><HR><H2
19312 CLASS="section"
19313 ><A
19314 NAME="UpdateSite"
19315 >2.110. UpdateSite</A
19316 ></H2
19317 ><P
19318 >Prototype:<A
19319 NAME="AEN6531"
19320 ></A
19321 ><BLOCKQUOTE
19322 CLASS="BLOCKQUOTE"
19323 ><P
19324 >UpdateSite (auth, site_id_or_login_base, site_fields)</P
19325 ></BLOCKQUOTE
19326 ></P
19327 ><P
19328 >Description:<A
19329 NAME="AEN6534"
19330 ></A
19331 ><BLOCKQUOTE
19332 CLASS="BLOCKQUOTE"
19333 ><P
19334 >Updates a site. Only the fields specified in update_fields are
19335 updated, all other fields are left untouched.</P
19336 ><P
19337 >PIs can only update sites they are a member of. Only admins can
19338 update max_slices, max_slivers, and login_base.</P
19339 ><P
19340 >Returns 1 if successful, faults otherwise.</P
19341 ></BLOCKQUOTE
19342 ></P
19343 ><P
19344 >Allowed Roles:<A
19345 NAME="AEN6539"
19346 ></A
19347 ><BLOCKQUOTE
19348 CLASS="BLOCKQUOTE"
19349 ><P
19350 >admin, pi</P
19351 ></BLOCKQUOTE
19352 ></P
19353 ><P
19354 >Parameters:</P
19355 ><P
19356 ></P
19357 ><UL
19358 ><LI
19359 ><P
19360 >&#13;                          <CODE
19361 CLASS="parameter"
19362 >auth</CODE
19363 >
19364 : struct, API authentication structure                  </P
19365 ><P
19366 ></P
19367 ><UL
19368 ><LI
19369 ><P
19370 >&#13;                                          <CODE
19371 CLASS="parameter"
19372 >AuthMethod</CODE
19373 >
19374 : string, Authentication method to use                                  </P
19375 ></LI
19376 ></UL
19377 ></LI
19378 ><LI
19379 ><P
19380 >&#13;                          <CODE
19381 CLASS="parameter"
19382 >site_id_or_login_base</CODE
19383 >
19384 : int or string                 </P
19385 ><P
19386 ></P
19387 ><UL
19388 ><LI
19389 ><P
19390 >&#13;int, Site identifier                                      </P
19391 ></LI
19392 ><LI
19393 ><P
19394 >&#13;string, Site slice prefix                                 </P
19395 ></LI
19396 ></UL
19397 ></LI
19398 ><LI
19399 ><P
19400 >&#13;                          <CODE
19401 CLASS="parameter"
19402 >site_fields</CODE
19403 >
19404 : struct                        </P
19405 ><P
19406 ></P
19407 ><UL
19408 ><LI
19409 ><P
19410 >&#13;                                          <CODE
19411 CLASS="parameter"
19412 >name</CODE
19413 >
19414 : string, Full site name                                        </P
19415 ></LI
19416 ><LI
19417 ><P
19418 >&#13;                                          <CODE
19419 CLASS="parameter"
19420 >url</CODE
19421 >
19422 : string, URL of a page that describes the site                                 </P
19423 ></LI
19424 ><LI
19425 ><P
19426 >&#13;                                          <CODE
19427 CLASS="parameter"
19428 >enabled</CODE
19429 >
19430 : boolean, Has been enabled                                     </P
19431 ></LI
19432 ><LI
19433 ><P
19434 >&#13;                                          <CODE
19435 CLASS="parameter"
19436 >longitude</CODE
19437 >
19438 : double, Decimal longitude of the site                                 </P
19439 ></LI
19440 ><LI
19441 ><P
19442 >&#13;                                          <CODE
19443 CLASS="parameter"
19444 >latitude</CODE
19445 >
19446 : double, Decimal latitude of the site                                  </P
19447 ></LI
19448 ><LI
19449 ><P
19450 >&#13;                                          <CODE
19451 CLASS="parameter"
19452 >max_slices</CODE
19453 >
19454 : int, Maximum number of slices that the site is able to create                                 </P
19455 ></LI
19456 ><LI
19457 ><P
19458 >&#13;                                          <CODE
19459 CLASS="parameter"
19460 >login_base</CODE
19461 >
19462 : string, Site slice prefix                                     </P
19463 ></LI
19464 ><LI
19465 ><P
19466 >&#13;                                          <CODE
19467 CLASS="parameter"
19468 >max_slivers</CODE
19469 >
19470 : int, Maximum number of slivers that the site is able to create                                        </P
19471 ></LI
19472 ><LI
19473 ><P
19474 >&#13;                                          <CODE
19475 CLASS="parameter"
19476 >is_public</CODE
19477 >
19478 : boolean, Publicly viewable site                                       </P
19479 ></LI
19480 ><LI
19481 ><P
19482 >&#13;                                          <CODE
19483 CLASS="parameter"
19484 >abbreviated_name</CODE
19485 >
19486 : string, Abbreviated site name                                 </P
19487 ></LI
19488 ></UL
19489 ></LI
19490 ></UL
19491 ><P
19492 >Returns:</P
19493 ><P
19494 ></P
19495 ><UL
19496 ><LI
19497 ><P
19498 >&#13;int, 1 if successful                      </P
19499 ></LI
19500 ></UL
19501 ></DIV
19502 ><DIV
19503 CLASS="section"
19504 ><HR><H2
19505 CLASS="section"
19506 ><A
19507 NAME="UpdateSliceAttribute"
19508 >2.111. UpdateSliceAttribute</A
19509 ></H2
19510 ><P
19511 >Prototype:<A
19512 NAME="AEN6599"
19513 ></A
19514 ><BLOCKQUOTE
19515 CLASS="BLOCKQUOTE"
19516 ><P
19517 >UpdateSliceAttribute (auth, slice_attribute_id, value)</P
19518 ></BLOCKQUOTE
19519 ></P
19520 ><P
19521 >Description:<A
19522 NAME="AEN6602"
19523 ></A
19524 ><BLOCKQUOTE
19525 CLASS="BLOCKQUOTE"
19526 ><P
19527 >Updates the value of an existing slice or sliver attribute.</P
19528 ><P
19529 >Users may only update attributes of slices or slivers of which
19530 they are members. PIs may only update attributes of slices or
19531 slivers at their sites, or of which they are members. Admins may
19532 update attributes of any slice or sliver.</P
19533 ><P
19534 >Returns 1 if successful, faults otherwise.</P
19535 ></BLOCKQUOTE
19536 ></P
19537 ><P
19538 >Allowed Roles:<A
19539 NAME="AEN6607"
19540 ></A
19541 ><BLOCKQUOTE
19542 CLASS="BLOCKQUOTE"
19543 ><P
19544 >admin, pi, user</P
19545 ></BLOCKQUOTE
19546 ></P
19547 ><P
19548 >Parameters:</P
19549 ><P
19550 ></P
19551 ><UL
19552 ><LI
19553 ><P
19554 >&#13;                          <CODE
19555 CLASS="parameter"
19556 >auth</CODE
19557 >
19558 : struct, API authentication structure                  </P
19559 ><P
19560 ></P
19561 ><UL
19562 ><LI
19563 ><P
19564 >&#13;                                          <CODE
19565 CLASS="parameter"
19566 >AuthMethod</CODE
19567 >
19568 : string, Authentication method to use                                  </P
19569 ></LI
19570 ></UL
19571 ></LI
19572 ><LI
19573 ><P
19574 >&#13;                          <CODE
19575 CLASS="parameter"
19576 >slice_attribute_id</CODE
19577 >
19578 : int, Slice attribute identifier                       </P
19579 ></LI
19580 ><LI
19581 ><P
19582 >&#13;                          <CODE
19583 CLASS="parameter"
19584 >value</CODE
19585 >
19586 : string, Slice attribute value                 </P
19587 ></LI
19588 ></UL
19589 ><P
19590 >Returns:</P
19591 ><P
19592 ></P
19593 ><UL
19594 ><LI
19595 ><P
19596 >&#13;int, 1 if successful                      </P
19597 ></LI
19598 ></UL
19599 ></DIV
19600 ><DIV
19601 CLASS="section"
19602 ><HR><H2
19603 CLASS="section"
19604 ><A
19605 NAME="UpdateSliceAttributeType"
19606 >2.112. UpdateSliceAttributeType</A
19607 ></H2
19608 ><P
19609 >Prototype:<A
19610 NAME="AEN6631"
19611 ></A
19612 ><BLOCKQUOTE
19613 CLASS="BLOCKQUOTE"
19614 ><P
19615 >UpdateSliceAttributeType (auth, attribute_type_id_or_name, attribute_type_fields)</P
19616 ></BLOCKQUOTE
19617 ></P
19618 ><P
19619 >Description:<A
19620 NAME="AEN6634"
19621 ></A
19622 ><BLOCKQUOTE
19623 CLASS="BLOCKQUOTE"
19624 ><P
19625 >Updates the parameters of an existing attribute with the values in
19626 attribute_type_fields.</P
19627 ><P
19628 >Returns 1 if successful, faults otherwise.</P
19629 ></BLOCKQUOTE
19630 ></P
19631 ><P
19632 >Allowed Roles:<A
19633 NAME="AEN6638"
19634 ></A
19635 ><BLOCKQUOTE
19636 CLASS="BLOCKQUOTE"
19637 ><P
19638 >admin</P
19639 ></BLOCKQUOTE
19640 ></P
19641 ><P
19642 >Parameters:</P
19643 ><P
19644 ></P
19645 ><UL
19646 ><LI
19647 ><P
19648 >&#13;                          <CODE
19649 CLASS="parameter"
19650 >auth</CODE
19651 >
19652 : struct, API authentication structure                  </P
19653 ><P
19654 ></P
19655 ><UL
19656 ><LI
19657 ><P
19658 >&#13;                                          <CODE
19659 CLASS="parameter"
19660 >AuthMethod</CODE
19661 >
19662 : string, Authentication method to use                                  </P
19663 ></LI
19664 ></UL
19665 ></LI
19666 ><LI
19667 ><P
19668 >&#13;                          <CODE
19669 CLASS="parameter"
19670 >attribute_type_id_or_name</CODE
19671 >
19672 : int or string                 </P
19673 ><P
19674 ></P
19675 ><UL
19676 ><LI
19677 ><P
19678 >&#13;int, Slice attribute type identifier                                      </P
19679 ></LI
19680 ><LI
19681 ><P
19682 >&#13;string, Slice attribute type name                                 </P
19683 ></LI
19684 ></UL
19685 ></LI
19686 ><LI
19687 ><P
19688 >&#13;                          <CODE
19689 CLASS="parameter"
19690 >attribute_type_fields</CODE
19691 >
19692 : struct                        </P
19693 ><P
19694 ></P
19695 ><UL
19696 ><LI
19697 ><P
19698 >&#13;                                          <CODE
19699 CLASS="parameter"
19700 >min_role_id</CODE
19701 >
19702 : int, Minimum (least powerful) role that can set or change this attribute                                      </P
19703 ></LI
19704 ><LI
19705 ><P
19706 >&#13;                                          <CODE
19707 CLASS="parameter"
19708 >name</CODE
19709 >
19710 : string, Slice attribute type name                                     </P
19711 ></LI
19712 ><LI
19713 ><P
19714 >&#13;                                          <CODE
19715 CLASS="parameter"
19716 >description</CODE
19717 >
19718 : string, Slice attribute type description                                      </P
19719 ></LI
19720 ></UL
19721 ></LI
19722 ></UL
19723 ><P
19724 >Returns:</P
19725 ><P
19726 ></P
19727 ><UL
19728 ><LI
19729 ><P
19730 >&#13;int, 1 if successful                      </P
19731 ></LI
19732 ></UL
19733 ></DIV
19734 ><DIV
19735 CLASS="section"
19736 ><HR><H2
19737 CLASS="section"
19738 ><A
19739 NAME="UpdateSlice"
19740 >2.113. UpdateSlice</A
19741 ></H2
19742 ><P
19743 >Prototype:<A
19744 NAME="AEN6677"
19745 ></A
19746 ><BLOCKQUOTE
19747 CLASS="BLOCKQUOTE"
19748 ><P
19749 >UpdateSlice (auth, slice_id_or_name, slice_fields)</P
19750 ></BLOCKQUOTE
19751 ></P
19752 ><P
19753 >Description:<A
19754 NAME="AEN6680"
19755 ></A
19756 ><BLOCKQUOTE
19757 CLASS="BLOCKQUOTE"
19758 ><P
19759 >Updates the parameters of an existing slice with the values in
19760 slice_fields.</P
19761 ><P
19762 >Users may only update slices of which they are members. PIs may
19763 update any of the slices at their sites, or any slices of which
19764 they are members. Admins may update any slice.</P
19765 ><P
19766 >Only PIs and admins may update max_nodes. Slices cannot be renewed
19767 (by updating the expires parameter) more than 8 weeks into the
19768 future.</P
19769 ><P
19770 >Returns 1 if successful, faults otherwise.</P
19771 ></BLOCKQUOTE
19772 ></P
19773 ><P
19774 >Allowed Roles:<A
19775 NAME="AEN6686"
19776 ></A
19777 ><BLOCKQUOTE
19778 CLASS="BLOCKQUOTE"
19779 ><P
19780 >admin, pi, user</P
19781 ></BLOCKQUOTE
19782 ></P
19783 ><P
19784 >Parameters:</P
19785 ><P
19786 ></P
19787 ><UL
19788 ><LI
19789 ><P
19790 >&#13;                          <CODE
19791 CLASS="parameter"
19792 >auth</CODE
19793 >
19794 : struct, API authentication structure                  </P
19795 ><P
19796 ></P
19797 ><UL
19798 ><LI
19799 ><P
19800 >&#13;                                          <CODE
19801 CLASS="parameter"
19802 >AuthMethod</CODE
19803 >
19804 : string, Authentication method to use                                  </P
19805 ></LI
19806 ></UL
19807 ></LI
19808 ><LI
19809 ><P
19810 >&#13;                          <CODE
19811 CLASS="parameter"
19812 >slice_id_or_name</CODE
19813 >
19814 : int or string                 </P
19815 ><P
19816 ></P
19817 ><UL
19818 ><LI
19819 ><P
19820 >&#13;int, Slice identifier                                     </P
19821 ></LI
19822 ><LI
19823 ><P
19824 >&#13;string, Slice name                                        </P
19825 ></LI
19826 ></UL
19827 ></LI
19828 ><LI
19829 ><P
19830 >&#13;                          <CODE
19831 CLASS="parameter"
19832 >slice_fields</CODE
19833 >
19834 : struct                        </P
19835 ><P
19836 ></P
19837 ><UL
19838 ><LI
19839 ><P
19840 >&#13;                                          <CODE
19841 CLASS="parameter"
19842 >url</CODE
19843 >
19844 : string, URL further describing this slice                                     </P
19845 ></LI
19846 ><LI
19847 ><P
19848 >&#13;                                          <CODE
19849 CLASS="parameter"
19850 >max_nodes</CODE
19851 >
19852 : int, Maximum number of nodes that can be assigned to this slice                                       </P
19853 ></LI
19854 ><LI
19855 ><P
19856 >&#13;                                          <CODE
19857 CLASS="parameter"
19858 >instantiation</CODE
19859 >
19860 : string, Slice instantiation state                                     </P
19861 ></LI
19862 ><LI
19863 ><P
19864 >&#13;                                          <CODE
19865 CLASS="parameter"
19866 >expires</CODE
19867 >
19868 : int, Date and time when slice expires, in seconds since UNIX epoch                                    </P
19869 ></LI
19870 ><LI
19871 ><P
19872 >&#13;                                          <CODE
19873 CLASS="parameter"
19874 >description</CODE
19875 >
19876 : string, Slice description                                     </P
19877 ></LI
19878 ></UL
19879 ></LI
19880 ></UL
19881 ><P
19882 >Returns:</P
19883 ><P
19884 ></P
19885 ><UL
19886 ><LI
19887 ><P
19888 >&#13;int, 1 if successful                      </P
19889 ></LI
19890 ></UL
19891 ></DIV
19892 ><DIV
19893 CLASS="section"
19894 ><HR><H2
19895 CLASS="section"
19896 ><A
19897 NAME="VerifyPerson"
19898 >2.114. VerifyPerson</A
19899 ></H2
19900 ><P
19901 >Prototype:<A
19902 NAME="AEN6731"
19903 ></A
19904 ><BLOCKQUOTE
19905 CLASS="BLOCKQUOTE"
19906 ><P
19907 >VerifyPerson (auth, person_id_or_email, verification_key, verification_expires)</P
19908 ></BLOCKQUOTE
19909 ></P
19910 ><P
19911 >Description:<A
19912 NAME="AEN6734"
19913 ></A
19914 ><BLOCKQUOTE
19915 CLASS="BLOCKQUOTE"
19916 ><P
19917 >Verify a new (must be disabled) user's e-mail address and registration.</P
19918 ><P
19919 >If verification_key is not specified, then a new verification_key
19920 will be generated and stored with the user's account. The key will
19921 be e-mailed to the user in the form of a link to a web page.</P
19922 ><P
19923 >The web page should verify the key by calling this function again
19924 and specifying verification_key. If the key matches what has been
19925 stored in the user's account, then an e-mail will be sent to the
19926 user's PI (and support if the user is requesting a PI role),
19927 asking the PI (or support) to enable the account.</P
19928 ><P
19929 >Returns 1 if the verification key if valid.</P
19930 ></BLOCKQUOTE
19931 ></P
19932 ><P
19933 >Allowed Roles:<A
19934 NAME="AEN6740"
19935 ></A
19936 ><BLOCKQUOTE
19937 CLASS="BLOCKQUOTE"
19938 ><P
19939 >admin</P
19940 ></BLOCKQUOTE
19941 ></P
19942 ><P
19943 >Parameters:</P
19944 ><P
19945 ></P
19946 ><UL
19947 ><LI
19948 ><P
19949 >&#13;                          <CODE
19950 CLASS="parameter"
19951 >auth</CODE
19952 >
19953 : struct, API authentication structure                  </P
19954 ><P
19955 ></P
19956 ><UL
19957 ><LI
19958 ><P
19959 >&#13;                                          <CODE
19960 CLASS="parameter"
19961 >AuthMethod</CODE
19962 >
19963 : string, Authentication method to use                                  </P
19964 ></LI
19965 ></UL
19966 ></LI
19967 ><LI
19968 ><P
19969 >&#13;                          <CODE
19970 CLASS="parameter"
19971 >person_id_or_email</CODE
19972 >
19973 : int or string                 </P
19974 ><P
19975 ></P
19976 ><UL
19977 ><LI
19978 ><P
19979 >&#13;int, User identifier                                      </P
19980 ></LI
19981 ><LI
19982 ><P
19983 >&#13;string, Primary e-mail address                                    </P
19984 ></LI
19985 ></UL
19986 ></LI
19987 ><LI
19988 ><P
19989 >&#13;                          <CODE
19990 CLASS="parameter"
19991 >verification_key</CODE
19992 >
19993 : string, Reset password key                    </P
19994 ></LI
19995 ><LI
19996 ><P
19997 >&#13;                          <CODE
19998 CLASS="parameter"
19999 >verification_expires</CODE
20000 >
20001 : int, Date and time when verification_key expires                      </P
20002 ></LI
20003 ></UL
20004 ><P
20005 >Returns:</P
20006 ><P
20007 ></P
20008 ><UL
20009 ><LI
20010 ><P
20011 >&#13;int, 1 if verification_key is valid                       </P
20012 ></LI
20013 ></UL
20014 ></DIV
20015 ><DIV
20016 CLASS="section"
20017 ><HR><H2
20018 CLASS="section"
20019 ><A
20020 NAME="system.listMethods"
20021 >2.115. system.listMethods</A
20022 ></H2
20023 ><P
20024 >Prototype:<A
20025 NAME="AEN6772"
20026 ></A
20027 ><BLOCKQUOTE
20028 CLASS="BLOCKQUOTE"
20029 ><P
20030 >system.listMethods ()</P
20031 ></BLOCKQUOTE
20032 ></P
20033 ><P
20034 >Description:<A
20035 NAME="AEN6775"
20036 ></A
20037 ><BLOCKQUOTE
20038 CLASS="BLOCKQUOTE"
20039 ><P
20040 >This method lists all the methods that the XML-RPC server knows
20041 how to dispatch.</P
20042 ></BLOCKQUOTE
20043 ></P
20044 ><P
20045 >Allowed Roles:<A
20046 NAME="AEN6778"
20047 ></A
20048 ><BLOCKQUOTE
20049 CLASS="BLOCKQUOTE"
20050 ><P
20051 ></P
20052 ></BLOCKQUOTE
20053 ></P
20054 ><P
20055 >Parameters:</P
20056 ><P
20057 ></P
20058 ><UL
20059 ><LI
20060 ><P
20061 >None</P
20062 ></LI
20063 ></UL
20064 ><P
20065 >Returns:</P
20066 ><P
20067 ></P
20068 ><UL
20069 ><LI
20070 ><P
20071 >&#13;array, List of methods                    </P
20072 ></LI
20073 ></UL
20074 ></DIV
20075 ><DIV
20076 CLASS="section"
20077 ><HR><H2
20078 CLASS="section"
20079 ><A
20080 NAME="system.methodHelp"
20081 >2.116. system.methodHelp</A
20082 ></H2
20083 ><P
20084 >Prototype:<A
20085 NAME="AEN6791"
20086 ></A
20087 ><BLOCKQUOTE
20088 CLASS="BLOCKQUOTE"
20089 ><P
20090 >system.methodHelp (method)</P
20091 ></BLOCKQUOTE
20092 ></P
20093 ><P
20094 >Description:<A
20095 NAME="AEN6794"
20096 ></A
20097 ><BLOCKQUOTE
20098 CLASS="BLOCKQUOTE"
20099 ><P
20100 >Returns help text if defined for the method passed, otherwise
20101 returns an empty string.</P
20102 ></BLOCKQUOTE
20103 ></P
20104 ><P
20105 >Allowed Roles:<A
20106 NAME="AEN6797"
20107 ></A
20108 ><BLOCKQUOTE
20109 CLASS="BLOCKQUOTE"
20110 ><P
20111 ></P
20112 ></BLOCKQUOTE
20113 ></P
20114 ><P
20115 >Parameters:</P
20116 ><P
20117 ></P
20118 ><UL
20119 ><LI
20120 ><P
20121 >&#13;                          <CODE
20122 CLASS="parameter"
20123 >method</CODE
20124 >
20125 : string, Method name                   </P
20126 ></LI
20127 ></UL
20128 ><P
20129 >Returns:</P
20130 ><P
20131 ></P
20132 ><UL
20133 ><LI
20134 ><P
20135 >&#13;string, Method help                       </P
20136 ></LI
20137 ></UL
20138 ></DIV
20139 ><DIV
20140 CLASS="section"
20141 ><HR><H2
20142 CLASS="section"
20143 ><A
20144 NAME="system.methodSignature"
20145 >2.117. system.methodSignature</A
20146 ></H2
20147 ><P
20148 >Prototype:<A
20149 NAME="AEN6811"
20150 ></A
20151 ><BLOCKQUOTE
20152 CLASS="BLOCKQUOTE"
20153 ><P
20154 >system.methodSignature (method)</P
20155 ></BLOCKQUOTE
20156 ></P
20157 ><P
20158 >Description:<A
20159 NAME="AEN6814"
20160 ></A
20161 ><BLOCKQUOTE
20162 CLASS="BLOCKQUOTE"
20163 ><P
20164 >Returns an array of known signatures (an array of arrays) for the
20165 method name passed. If no signatures are known, returns a
20166 none-array (test for type != array to detect missing signature).</P
20167 ></BLOCKQUOTE
20168 ></P
20169 ><P
20170 >Allowed Roles:<A
20171 NAME="AEN6817"
20172 ></A
20173 ><BLOCKQUOTE
20174 CLASS="BLOCKQUOTE"
20175 ><P
20176 ></P
20177 ></BLOCKQUOTE
20178 ></P
20179 ><P
20180 >Parameters:</P
20181 ><P
20182 ></P
20183 ><UL
20184 ><LI
20185 ><P
20186 >&#13;                          <CODE
20187 CLASS="parameter"
20188 >method</CODE
20189 >
20190 : string, Method name                   </P
20191 ></LI
20192 ></UL
20193 ><P
20194 >Returns:</P
20195 ><P
20196 ></P
20197 ><UL
20198 ><LI
20199 ><P
20200 >&#13;array of array, Method signature                  </P
20201 ><P
20202 ></P
20203 ><UL
20204 ><LI
20205 ><P
20206 >&#13;string                                    </P
20207 ></LI
20208 ></UL
20209 ></LI
20210 ></UL
20211 ></DIV
20212 ><DIV
20213 CLASS="section"
20214 ><HR><H2
20215 CLASS="section"
20216 ><A
20217 NAME="system.multicall"
20218 >2.118. system.multicall</A
20219 ></H2
20220 ><P
20221 >Prototype:<A
20222 NAME="AEN6834"
20223 ></A
20224 ><BLOCKQUOTE
20225 CLASS="BLOCKQUOTE"
20226 ><P
20227 >system.multicall (calls)</P
20228 ></BLOCKQUOTE
20229 ></P
20230 ><P
20231 >Description:<A
20232 NAME="AEN6837"
20233 ></A
20234 ><BLOCKQUOTE
20235 CLASS="BLOCKQUOTE"
20236 ><P
20237 >Process an array of calls, and return an array of results. Calls
20238 should be structs of the form</P
20239 ><P
20240 >{'methodName': string, 'params': array}</P
20241 ><P
20242 >Each result will either be a single-item array containg the result
20243 value, or a struct of the form</P
20244 ><P
20245 >{'faultCode': int, 'faultString': string}</P
20246 ><P
20247 >This is useful when you need to make lots of small calls without
20248 lots of round trips.</P
20249 ></BLOCKQUOTE
20250 ></P
20251 ><P
20252 >Allowed Roles:<A
20253 NAME="AEN6844"
20254 ></A
20255 ><BLOCKQUOTE
20256 CLASS="BLOCKQUOTE"
20257 ><P
20258 ></P
20259 ></BLOCKQUOTE
20260 ></P
20261 ><P
20262 >Parameters:</P
20263 ><P
20264 ></P
20265 ><UL
20266 ><LI
20267 ><P
20268 >&#13;                          <CODE
20269 CLASS="parameter"
20270 >calls</CODE
20271 >
20272 : array of struct                       </P
20273 ><P
20274 ></P
20275 ><UL
20276 ><LI
20277 ><P
20278 >&#13;                                          <CODE
20279 CLASS="parameter"
20280 >params</CODE
20281 >
20282 : array, Method arguments                                       </P
20283 ></LI
20284 ><LI
20285 ><P
20286 >&#13;                                          <CODE
20287 CLASS="parameter"
20288 >methodName</CODE
20289 >
20290 : string, Method name                                   </P
20291 ></LI
20292 ></UL
20293 ></LI
20294 ></UL
20295 ><P
20296 >Returns:</P
20297 ><P
20298 ></P
20299 ><UL
20300 ><LI
20301 ><P
20302 >&#13;array of mixed or struct                  </P
20303 ><P
20304 ></P
20305 ><UL
20306 ><LI
20307 ><P
20308 >&#13;array of mixed                                    </P
20309 ></LI
20310 ><LI
20311 ><P
20312 >&#13;struct                                    </P
20313 ><P
20314 ></P
20315 ><UL
20316 ><LI
20317 ><P
20318 >&#13;                                                          <CODE
20319 CLASS="parameter"
20320 >faultCode</CODE
20321 >
20322 : int, XML-RPC fault code                                                       </P
20323 ></LI
20324 ><LI
20325 ><P
20326 >&#13;                                                          <CODE
20327 CLASS="parameter"
20328 >faultString</CODE
20329 >
20330 : int, XML-RPC fault detail                                                     </P
20331 ></LI
20332 ></UL
20333 ></LI
20334 ></UL
20335 ></LI
20336 ></UL
20337 ></DIV
20338 ></DIV
20339 ></DIV
20340 ></BODY
20341 ></HTML
20342 >