Update node settings and properties
643 matches
100 actions
Rudder
100 actions
- Check if Rudder is aliveGETv1.0.0
- Compliance details by nodeGETv1.0.0
- Compliance details by ruleGETv1.0.0
- Compliance details for all nodesGETv1.0.0
- Compliance details for all rulesGETv1.0.0
- Create a data sourcePUTv1.0.0
- Create a directivePUTv1.0.0
- Create a groupPUTv1.0.0
- Create a group categoryPUTv1.0.0
- Create a new parameterPUTv1.0.0
- Create a rulePUTv1.0.0
- Create a rule categoryPUTv1.0.0
- Create a secretPUTv1.0.0
- Create an archivePOSTv1.0.0
- Create one or several new nodesPUTv1.0.0
- Create techniquePUTv1.0.0
- Delete a data sourceDELETEv1.0.0
- Delete a directiveDELETEv1.0.0
- Delete a groupDELETEv1.0.0
- Delete a nodeDELETEv1.0.0
- Delete a parameterDELETEv1.0.0
- Delete a ruleDELETEv1.0.0
- Delete a secretDELETEv1.0.0
- Delete an userDELETEv1.0.0
- Delete group categoryDELETEv1.0.0
- Delete group categoryDELETEv1.0.0
- Delete techniqueDELETEv1.0.0
- Get a change request detailsGETv1.0.0
- Get a list of CVE detailsPOSTv1.0.0
- Get a rule detailsGETv1.0.0
- Get all CVE detailsGETv1.0.0
- Get allowed networks for a policy serverGETv1.0.0
- Get an archive as a ZIPGETv1.0.0
- Get branding configurationGETv1.0.0
- Get CVE check configGETv1.0.0
- Get data source configurationGETv1.0.0
- Get directive detailsGETv1.0.0
- Get group category detailsGETv1.0.0
- Get group detailsGETv1.0.0
- Get groups treeGETv1.0.0
- Get information about a nodeGETv1.0.0
- Get information about inventory processing queueGETv1.0.0
- Get information about one API endpointGETv1.0.0
- Get information on endpoint in a sectionGETv1.0.0
- Get inherited node properties for a nodeGETv1.0.0
- Get last CVE check resultGETv1.0.0
- Get nodes acceptation statusGETv1.0.0
- Get one secretGETv1.0.0
- Get rule category detailsGETv1.0.0
- Get rules treeGETv1.0.0
- Get server informationGETv1.0.0
- Get server statusGETv1.0.0
- Get the value of a parameterGETv1.0.0
- Get the value of a settingGETv1.0.0
- Global complianceGETv1.0.0
- List all change requestsGETv1.0.0
- List all data sourcesGETv1.0.0
- List all directivesGETv1.0.0
- List all directives based on a techniqueGETv1.0.0
- List all endointsGETv1.0.0
- List all global parametersGETv1.0.0
- List all groupsGETv1.0.0
- List all rolesGETv1.0.0
- List all rulesGETv1.0.0
- List all secretsGETv1.0.0
- List all settingsGETv1.0.0
- List all techniquesGETv1.0.0
- List all usersGETv1.0.0
- List archivesGETv1.0.0
- List categoriesGETv1.0.0
- List managed nodesGETv1.0.0
- List methodsGETv1.0.0
- List pending nodesGETv1.0.0
- List userGETv1.0.0
- Reload userGETv1.0.0
- Technique's resourcesGETv1.0.0
- Technique's revisionsGETv1.0.0
- Trigger update of policiesPOSTv1.0.0
- Update a data source configurationPOSTv1.0.0
- Update a directive detailsPOSTv1.0.0
- Update a parameter's valuePOSTv1.0.0
- Update a request detailsPOSTv1.0.0
- Update a rule detailsPOSTv1.0.0
- Update a secretPOSTv1.0.0
- Update cve check configPOSTv1.0.0
- Update CVE database from file systemPOSTv1.0.0
- Update CVE database from remote sourcePOSTv1.0.0
- Update group category detailsPOSTv1.0.0
- Update group detailsPOSTv1.0.0
- Update node settings and propertiesPOSTv1.0.0
- Update pending Node statusPOSTv1.0.0
- Update properties for one node from a data sourcePOSTv1.0.0
- Update properties for one node from all data sourcesPOSTv1.0.0
- Update properties from data sourcesPOSTv1.0.0
- Update properties from data sourcesPOSTv1.0.0
- Update rule category detailsPOSTv1.0.0
- Update techniquePOSTv1.0.0
- Update user's infosPOSTv1.0.0
- Update validated user listPOSTv1.0.0
- Update web interface customizationPOSTv1.0.0
Other/Rudder
Update node settings and properties
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
{
"type": "object",
"properties": {
"agentKey": {
"type": "object",
"description": "Information about agent key or certificate",
"required": [
"value"
],
"properties": {
"status": {
"type": "string",
"description": "Certification status of the security token (reset to `undefined` to trust a new certificate). If `certified`, inventory signature check will be enforced",
"enum": [
"certified",
"undefined"
]
},
"value": {
"type": "string",
"format": "PEM",
"description": "Certificate (or public key for <6.0 agents) used by the agent. Be careful write a \"\\n\" after header line and before footer line, JSON does not keep formatting in string."
}
}
},
"nodeId": {
"type": "string",
"format": "uuid (or \"root\")"
},
"policyMode": {
"type": "string",
"description": "In which mode the node will apply its configuration policy. Use `default` to use the global mode.",
"enum": [
"audit",
"enforce",
"default"
]
},
"properties": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Property name"
},
"value": {
"format": "string or JSON",
"description": "Property value (can be a string or JSON object)",
"type": "object"
}
}
}
},
"state": {
"type": "string",
"description": "The node life cycle state. See [dedicated doc](https://docs.rudder.io/reference/current/usage/advanced_node_management.html#node-lifecycle) for more information.",
"enum": [
"enabled",
"ignored",
"empty-policies",
"initializing",
"preparing-eol"
]
}
},
"required": [
"nodeId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
- 534
- 535
- 536
- 537
- 538
- 539
- 540
- 541
- 542
- 543
- 544
- 545
- 546
- 547
- 548
- 549
- 550
- 551
- 552
- 553
- 554
- 555
- 556
- 557
- 558
- 559
- 560
- 561
- 562
- 563
- 564
- 565
- 566
- 567
- 568
- 569
- 570
- 571
- 572
- 573
- 574
- 575
- 576
- 577
- 578
- 579
- 580
- 581
- 582
- 583
- 584
- 585
- 586
- 587
- 588
- 589
- 590
- 591
- 592
- 593
- 594
- 595
- 596
- 597
- 598
- 599
- 600
- 601
- 602
- 603
- 604
- 605
- 606
- 607
- 608
- 609
- 610
- 611
- 612
- 613
- 614
- 615
- 616
- 617
- 618
- 619
- 620
- 621
- 622
- 623
- 624
- 625
- 626
- 627
- 628
- 629
- 630
- 631
- 632
- 633
- 634
- 635
- 636
- 637
- 638
- 639
- 640
- 641
- 642
- 643
- 644
- 645
- 646
- 647
- 648
- 649
- 650
- 651
- 652
- 653
- 654
- 655
- 656
- 657
- 658
- 659
- 660
- 661
- 662
- 663
- 664
- 665
- 666
- 667
- 668
- 669
- 670
- 671
- 672
- 673
- 674
- 675
- 676
- 677
- 678
- 679
- 680
- 681
- 682
- 683
- 684
- 685
- 686
- 687
- 688
- 689
- 690
- 691
- 692
- 693
- 694
- 695
- 696
- 697
- 698
- 699
- 700
- 701
- 702
- 703
- 704
- 705
- 706
- 707
- 708
- 709
- 710
- 711
- 712
- 713
- 714
- 715
- 716
- 717
- 718
- 719
- 720
- 721
- 722
- 723
- 724
- 725
- 726
- 727
- 728
- 729
- 730
- 731
- 732
- 733
- 734
- 735
- 736
- 737
- 738
- 739
- 740
- 741
- 742
- 743
- 744
- 745
- 746
- 747
- 748
- 749
- 750
- 751
- 752
- 753
- 754
- 755
- 756
- 757
- 758
- 759
- 760
- 761
- 762
- 763
- 764
- 765
- 766
- 767
- 768
- 769
- 770
- 771
- 772
- 773
- 774
- 775
- 776
- 777
- 778
- 779
- 780
- 781
- 782
- 783
- 784
- 785
- 786
- 787
- 788
- 789
- 790
- 791
- 792
- 793
- 794
- 795
- 796
- 797
- 798
- 799
- 800
- 801
- 802
- 803
- 804
- 805
- 806
- 807
- 808
- 809
- 810
- 811
- 812
- 813
- 814
- 815
- 816
- 817
- 818
- 819
- 820
- 821
- 822
- 823
- 824
- 825
- 826
- 827
- 828
- 829
- 830
- 831
- 832
- 833
- 834
- 835
- 836
- 837
- 838
- 839
- 840
- 841
- 842
- 843
- 844
- 845
- 846
- 847
- 848
- 849
- 850
- 851
- 852
- 853
- 854
- 855
- 856
- 857
- 858
- 859
- 860
- 861
- 862
- 863
- 864
- 865
- 866
- 867
- 868
- 869
- 870
- 871
- 872
- 873
- 874
- 875
- 876
- 877
- 878
- 879
- 880
- 881
- 882
- 883
- 884
- 885
- 886
- 887
- 888
- 889
- 890
- 891
- 892
- 893
- 894
- 895
- 896
- 897
- 898
- 899
- 900
- 901
- 902
- 903
- 904
- 905
- 906
- 907
- 908
- 909
- 910
- 911
- 912
- 913
- 914
- 915
- 916
- 917
- 918
- 919
- 920
- 921
- 922
- 923
- 924
{
"type": "object",
"required": [
"action",
"data",
"result"
],
"properties": {
"action": {
"type": "string",
"description": "The id of the action",
"enum": [
"updateNode"
]
},
"data": {
"type": "object",
"description": "Information about the node",
"required": [
"nodes"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"hostname",
"status",
"ipAddresses",
"managementTechnology",
"policyServerId",
"properties"
],
"properties": {
"accounts": {
"type": "array",
"description": "User accounts declared in the node",
"items": {
"type": "string",
"description": "User present on the system"
}
},
"architectureDescription": {
"type": "string",
"description": "Information about CPU architecture (32/64 bits)"
},
"bios": {
"type": "object",
"description": "BIOS information",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the BIOS (long name)"
},
"editor": {
"type": "string",
"description": "BIOS editor"
},
"name": {
"type": "string",
"description": "BIOS name"
},
"quantity": {
"type": "integer",
"description": "Number of BIOS on the machine"
},
"releaseDate": {
"type": "string",
"description": "Release date of the BIOS"
},
"version": {
"type": "string",
"description": "BIOS version"
}
}
},
"controllers": {
"type": "array",
"description": "Physical controller information",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the controller"
},
"manufacturer": {
"type": "string",
"description": "Controller manufacturer"
},
"name": {
"type": "string",
"description": "Controller name"
},
"quantity": {
"type": "integer",
"description": "Quantity of that controller"
},
"type": {
"type": "string",
"description": "Controller type"
}
}
}
},
"description": {
"type": "string",
"description": "A human intended description of the node (not used)"
},
"environmentVariables": {
"type": "array",
"description": "Environment variables defined on the node in the context of the agent",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Environment variable name"
},
"value": {
"type": "string",
"description": "Environment variable value"
}
}
}
},
"fileSystems": {
"type": "array",
"description": "File system declared on the node",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the file system"
},
"fileCount": {
"type": "integer",
"description": "Number of files"
},
"freeSpace": {
"type": "integer",
"description": "Free space remaining"
},
"mountPoint": {
"type": "string",
"description": "Mount point"
},
"name": {
"type": "string",
"description": "Type of file system (`ext4`, `swap`, etc.)"
},
"totalSpace": {
"type": "integer",
"description": "Total space"
}
}
}
},
"hostname": {
"type": "string",
"description": "Fully qualified name of the node"
},
"id": {
"type": "string",
"format": "uuid (or \"root\")",
"description": "Unique id of the node"
},
"ipAddresses": {
"type": "array",
"description": "IP addresses of the node (IPv4 and IPv6)",
"items": {
"type": "string",
"description": "IP of the node"
}
},
"lastInventoryDate": {
"type": "string",
"format": "date",
"description": "Date and time of the latest generated inventory, if one is available (node time). Up to API v11, format was: \"YYYY-MM-dd HH:mm\""
},
"lastRunDate": {
"type": "string",
"format": "date",
"description": "Date and time of the latest run, if one is available (node time). Up to API v11, format was: \"YYYY-MM-dd HH:mm\""
},
"machine": {
"type": "object",
"description": "Information about the underlying machine",
"properties": {
"id": {
"type": "string",
"description": "Rudder unique identifier for the machine"
},
"manufacturer": {
"type": "string",
"description": "Information about machine manufacturer"
},
"provider": {
"type": "string",
"description": "In the case of VM, the VM technology"
},
"serialNumber": {
"type": "string",
"description": "If available, a unique identifier provided by the machine"
},
"type": {
"type": "string",
"description": "Type of the machine",
"enum": [
"Physical",
"Virtual"
]
}
}
},
"managementTechnology": {
"type": "array",
"description": "Management agents running on the node",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"capabilities": {
"type": "array",
"description": "List of agent capabilities",
"items": {
"type": "string",
"description": "Special capacities of the agent, like parsing xml or yaml, support of advanced acl, etc."
}
},
"name": {
"type": "string",
"description": "Agent name"
},
"nodeKind": {
"type": "string",
"description": "kind of node for the management engine, like `root`, `relay`, `node`, `root-component`"
},
"rootComponents": {
"type": "array",
"description": "Roles fulfilled by the agent",
"items": {
"type": "string",
"description": "A role that node fulfills in management technology"
}
},
"version": {
"type": "string",
"description": "Agent version"
}
}
}
},
"managementTechnologyDetails": {
"type": "object",
"description": "Additional information about management technology",
"properties": {
"cfengineKeys": {
"type": "array",
"description": "Certificates used by the agent",
"items": {
"type": "string",
"format": "PEM",
"description": "Certificate (or public key for <6.0 agents) used by the agent"
}
},
"cfengineUser": {
"type": "string",
"description": "Local user account used by the agent"
}
}
},
"memories": {
"type": "array",
"description": "Memory slots",
"items": {
"type": "object",
"description": "Memory slots",
"properties": {
"capacity": {
"type": "integer",
"description": "Size of modules"
},
"caption": {
"type": "string",
"description": "Manufacturer provided information about the module"
},
"description": {
"type": "string",
"description": "System provided description"
},
"name": {
"type": "string",
"description": "Name of the memory slot or memory module"
},
"quantity": {
"type": "string",
"description": "Number of modules in that slot"
},
"serialNumber": {
"type": "string",
"description": "Serial number of the module"
},
"slotNumber": {
"type": "integer",
"description": "Slot number"
},
"speed": {
"type": "integer",
"description": "Memory speed (frequency)"
},
"type": {
"type": "string",
"description": "Memory slot type"
}
}
}
},
"networkInterfaces": {
"type": "array",
"description": "Detailed information about registered network interfaces on the node",
"items": {
"type": "object",
"properties": {
"dhcpServer": {
"type": "string",
"description": "DHCP server managing that network interface"
},
"ipAddresses": {
"type": "array",
"description": "IP addresses of the network interface",
"items": {
"type": "string",
"description": "IP address"
}
},
"macAddress": {
"type": "string",
"description": "MAC address of the network interface"
},
"mask": {
"type": "array",
"items": {
"type": "string",
"format": "CIDR",
"description": "Network interface mask"
}
},
"name": {
"type": "string",
"description": "Interface name (for ex \"eth0\")"
},
"speed": {
"type": "string",
"description": "Information about synchronization speed"
},
"status": {
"type": "string",
"description": "network interface status (enabled or not, up or down)"
},
"type": {
"type": "string",
"description": "Information about the type of network interface"
}
}
}
},
"os": {
"type": "object",
"description": "Information about the operating system",
"required": [
"type",
"name",
"version",
"fullName",
"kernelVersion"
],
"properties": {
"fullName": {
"type": "string",
"description": "Full operating system name"
},
"kernelVersion": {
"type": "string",
"description": "Version of the OS kernel"
},
"name": {
"type": "string",
"description": "Operating system name (distribution on Linux, etc.)"
},
"servicePack": {
"type": "string",
"description": "If relevant, the service pack of the OS"
},
"type": {
"type": "string",
"description": "Family of the OS",
"enum": [
"Windows",
"Linux",
"AIX",
"FreeBSD"
]
},
"version": {
"type": "string",
"description": "OS version"
}
}
},
"policyMode": {
"type": "string",
"description": "Rudder policy mode for the node (`default` follows the global configuration)",
"enum": [
"enforce",
"audit",
"default"
]
},
"policyServerId": {
"type": "string",
"format": "uuid (or \"root\")",
"description": "Rudder policy server managing the node"
},
"ports": {
"type": "array",
"description": "Physical port information objects",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the port"
},
"name": {
"type": "string",
"description": "Port name"
},
"quantity": {
"type": "integer",
"description": "Quantity of similar ports"
},
"type": {
"type": "string",
"description": "Port type"
}
}
}
},
"processes": {
"type": "array",
"description": "Process running (at inventory time)",
"items": {
"type": "object",
"description": "Process information",
"properties": {
"cpuUsage": {
"type": "integer",
"description": "CPU used by the process (at inventory time)"
},
"description": {
"type": "string",
"description": "System provided description about the process"
},
"memory": {
"type": "number",
"format": "float",
"description": "Memory allocated to the process (at inventory time)"
},
"name": {
"type": "string",
"description": "Process name"
},
"pid": {
"type": "integer",
"description": "PID of the process"
},
"started": {
"type": "string",
"format": "date",
"description": "Started date and time of the process"
},
"tty": {
"type": "string",
"description": "TTY to which the process is"
},
"user": {
"type": "string",
"description": "User account who started the process"
},
"virtualMemory": {
"type": "integer",
"description": "Virtual memory allocated to the process (at inventory time)"
}
}
}
},
"processors": {
"type": "array",
"description": "CPU information",
"items": {
"type": "object",
"properties": {
"arch": {
"type": "string",
"description": "CPU architecture"
},
"core": {
"type": "integer",
"description": "Number of core for that CPU"
},
"cpuid": {
"type": "string",
"description": "Identifier of the CPU"
},
"description": {
"type": "string",
"description": "System provided description of the CPU"
},
"externalClock": {
"type": "string",
"description": "External clock used by the CPU"
},
"familyName": {
"type": "string",
"description": "CPU family"
},
"manufacturer": {
"type": "string",
"description": "CPU manufacturer"
},
"model": {
"type": "integer",
"description": "CPU model"
},
"name": {
"type": "string",
"description": "CPU name"
},
"quantity": {
"type": "integer",
"description": "Number of CPU with these features"
},
"speed": {
"type": "integer",
"description": "Speed (frequency) of the CPU"
},
"stepping": {
"type": "integer",
"description": "Stepping or power management information"
},
"thread": {
"type": "integer",
"description": "Number of thread by core for the CPU"
}
}
}
},
"properties": {
"type": "array",
"description": "Node properties (either set by user or filled by third party sources)",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Property name"
},
"value": {
"format": "string or JSON",
"description": "Property value (can be a string or JSON object)",
"type": "object"
}
}
}
},
"ram": {
"type": "integer",
"description": "Size of RAM in MB"
},
"slots": {
"type": "array",
"description": "Physical extension slot information",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the slots"
},
"name": {
"type": "string",
"description": "Slot name or identifier"
},
"quantity": {
"type": "integer",
"description": "Quantity of similar slots"
},
"status": {
"type": "string",
"description": "Slot status (used, powered, etc)"
}
}
}
},
"software": {
"type": "array",
"description": "Software installed on the node (can have thousands items)",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A description of the software"
},
"editor": {
"type": "string",
"description": "Editor of the software"
},
"license": {
"type": "object",
"description": "Information about the license",
"properties": {
"description": {
"type": "string",
"description": "License description"
},
"expirationDate": {
"type": "string",
"format": "date",
"description": "License expiration date"
},
"name": {
"type": "string",
"description": "License name"
},
"oem": {
"type": "string",
"description": "Is this an OEM license (and information)"
},
"productId": {
"type": "string",
"description": "License product identifier"
},
"productKey": {
"type": "string",
"description": "License key"
}
}
},
"name": {
"type": "string",
"description": "Name of the software (as reported by the node)"
},
"releaseDate": {
"type": "string",
"format": "date",
"description": "Release date of the software"
},
"version": {
"type": "string",
"description": "Version of the software"
}
}
}
},
"softwareUpdate": {
"type": "array",
"description": "Software that can be updated on that machine",
"items": {
"type": "object",
"properties": {
"arch": {
"type": "string",
"description": "CPU architecture of the update"
},
"description": {
"type": "string",
"description": "details about the content of the update, if available"
},
"from": {
"type": "string",
"description": "tool that discovered that update"
},
"ids": {
"type": "array",
"items": {
"type": "string",
"description": "Related identifiers, can be CVE number, vendor-specific advisory (RHSA, etc.)"
}
},
"kind": {
"type": "string",
"description": "if available, kind of patch provided by that update, else none",
"enum": [
"none",
"security",
"defect",
"enhancement",
"other"
]
},
"name": {
"type": "string",
"description": "name of software that can be updated"
},
"severity": {
"type": "string",
"description": "if available, the severity of the update",
"enum": [
"critical",
"high",
"moderate",
"low",
"other"
]
},
"source": {
"type": "string",
"description": "information about the source providing that update"
},
"version": {
"type": "string",
"description": "available version for software"
}
}
}
},
"sound": {
"type": "array",
"description": "Sound card information",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the sound card"
},
"name": {
"type": "string",
"description": "Sound card name"
},
"quantity": {
"type": "integer",
"description": "Quantity of similar sound cards"
}
}
}
},
"status": {
"type": "string",
"description": "Status of the node",
"enum": [
"pending",
"accepted",
"deleted"
]
},
"storage": {
"type": "array",
"description": "Storage (disks) information objects",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided information about the storage"
},
"firmware": {
"type": "string",
"description": "Storage firmware information"
},
"manufacturer": {
"type": "string",
"description": "Storage manufacturer"
},
"model": {
"type": "string",
"description": "Storage model"
},
"name": {
"type": "string",
"description": "Storage name"
},
"quantity": {
"type": "integer",
"description": "Quantity of similar storage"
},
"serialNumber": {
"type": "string",
"description": "Storage serial number"
},
"size": {
"type": "integer",
"description": "Storage size in MB"
},
"type": {
"type": "string",
"description": "Storage type"
}
}
}
},
"timezone": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Timezone name"
},
"offset": {
"type": "string",
"format": "+/-difference",
"description": "Timezone offset to UTC"
}
}
},
"videos": {
"type": "array",
"description": "Video card information",
"items": {
"type": "object",
"properties": {
"chipset": {
"type": "string",
"description": "information about video card chipset"
},
"description": {
"type": "string",
"description": "System provided description for that video card"
},
"memory": {
"type": "string",
"description": "Quantity of memory for that video card"
},
"name": {
"type": "string",
"description": "Video card name"
},
"quantity": {
"type": "integer",
"description": "Quantity of similar video cards"
},
"resolution": {
"type": "string",
"description": "Resolution used by that video card at inventory time"
}
}
}
},
"virtualMachines": {
"type": "array",
"description": "Hosted virtual machine information",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "System provided description of the hosted virtual machine"
},
"memory": {
"type": "string",
"description": "Memory allocated to the hosted virtual machine"
},
"name": {
"type": "string",
"description": "Name of the hosted virtual machine"
},
"owner": {
"type": "string",
"description": "Owner of the hosted virtual machine"
},
"status": {
"type": "string",
"description": "Status (up, starting, etc) of the hosted virtual machine"
},
"subsystem": {
"type": "string",
"description": "Technology of the hosted virtual machine"
},
"type": {
"type": "string",
"description": "Type of the hosted virtual machine"
},
"uuid": {
"type": "string",
"description": "Unique identifier of the hosted virtual machine"
},
"vcpu": {
"type": "string",
"description": "Number of virtual CPU allocated to the hosted virtual machine"
}
}
}
}
}
}
}
}
},
"result": {
"type": "string",
"description": "Result of the request",
"enum": [
"success",
"error"
]
}
}
}