Lenovo XClarity Administrator REST API Guide · Before using this information and the product it...

Lenovo XClarity Administrator REST API Guide

Version 1.4.0

Note

Before using this information and the product it supports, read the general and legal notices in the Lenovo XClarity Administrator online documentation.

Eleventh Edition (November 2017)

© Copyright Lenovo 2015, 2017. LIMITED AND RESTRICTED RIGHTS NOTICE: If data or software is delivered pursuant a General Services Administration “GSA” contract, use, reproduction, or disclosure is subject to restrictions set forth in Contract No. GS-35F-05925.

http://flexsystem.lenovofiles.com/help/topic/com.lenovo.lxca.doc/notices.htmlhttp://flexsystem.lenovofiles.com/help/topic/com.lenovo.lxca.doc/notices.html

Contents

Summary of changes in the REST API . . . . . . . . . . . . . . . . . . . vii

Chapter 1. Lenovo XClarity Administrator Overview . . . . . . . . . 1

Chapter 2. Virtual appliance management . . . . . . . . . . . . . . . 5/aicc . . . . . . . . . . . . . . . . . . . . 5

GET /aicc . . . . . . . . . . . . . . . . 5PUT /aicc . . . . . . . . . . . . . . . 10

/aicc/network/ipdisable . . . . . . . . . . . . 14GET /aicc/network/ipdisable . . . . . . . . 14PUT /aicc/network/ipdisable . . . . . . . . 15

/aicc/network/host . . . . . . . . . . . . . 16GET /aicc/network/host . . . . . . . . . . 16PUT /aicc/network/host . . . . . . . . . . 18

/aicc/network/interfaces/ . . . . . . 19GET /aicc/network/interfaces/ . . . 19PUT /aicc/network/interfaces/ . . . 21

/aicc/network/routes . . . . . . . . . . . . . 23GET /aicc/network/routes . . . . . . . . . 23PUT /aicc/network/routes . . . . . . . . . 25

/aicc/subscriptions . . . . . . . . . . . . . 27GET /aicc/subscriptions. . . . . . . . . . 27POST /aicc/subscriptions . . . . . . . . . 28

/aicc/subscriptions/ . . . . . . . . . . . 31DELETE /aicc/subscriptions/ . . . . . . 31GET /aicc/subscriptions/ . . . . . . . 32

Chapter 3. Discovery and management resources . . . . . . . . 33/csvRequest . . . . . . . . . . . . . . . . 33

POST /csvRequest. . . . . . . . . . . . 33/csvRequest/jobs/ . . . . . . . . . . 36

GET /csvRequest/jobs/ . . . . . . 36/discovery . . . . . . . . . . . . . . . . . 43

GET /discovery . . . . . . . . . . . . . 43/discoverRequest . . . . . . . . . . . . . . 52

POST /discoverRequest. . . . . . . . . . 52/discoverRequest/jobs/ . . . . . . . . 53

GET /discoverRequest/jobs/ . . . . 53/manageRequest . . . . . . . . . . . . . . 60

POST /manageRequest . . . . . . . . . . 61/manageRequest/jobs/ . . . . . . . . 65

GET /manageRequest/jobs/. . . . . 65/unmanageRequest . . . . . . . . . . . . . 68

POST /unmanageRequest . . . . . . . . . 69/unmanageRequest/jobs/ . . . . . . . 70

GET /unmanageRequest/jobs/. . . . 70

Chapter 4. Inventory resources . . . . 75/canisters . . . . . . . . . . . . . . . . . 75

GET /canisters . . . . . . . . . . . . . 75/canisters/. . . . . . . . . . . . . . 78

GET /canisters/ . . . . . . . . . . 79PUT /canisters/ . . . . . . . . . . 87

/chassis . . . . . . . . . . . . . . . . . . 91GET /chassis . . . . . . . . . . . . . . 91

/chassis/ . . . . . . . . . . . . . . 107GET /chassis/ . . . . . . . . . 107PUT /chassis/ . . . . . . . . . . 130

/cmms . . . . . . . . . . . . . . . . . . 136GET /cmms . . . . . . . . . . . . . . 136

/cmms/ . . . . . . . . . . . . . . . 139GET /cmms/ . . . . . . . . . 139PUT /cmms/ . . . . . . . . . . . 146

/fans . . . . . . . . . . . . . . . . . . . 150GET /fans . . . . . . . . . . . . . . . 150

/fans/ . . . . . . . . . . . . . . . 152GET /fans/ . . . . . . . . . . . . 152

/fanMuxes . . . . . . . . . . . . . . . . . 156GET /fanMuxes . . . . . . . . . . . . . 156

/fanMuxes/ . . . . . . . . . . . . . 158GET /fanMuxes/ . . . . . . . . . 158

/nodes . . . . . . . . . . . . . . . . . . 161GET /nodes . . . . . . . . . . . . . . 161

/nodes/ . . . . . . . . . . . . . . . 177GET /nodes/ . . . . . . . . . 177PUT /nodes/ . . . . . . . . . . . 214

/nodes//bmc. . . . . . . . . . . . . 222PUT /nodes//bmc . . . . . . . . . 222

/powerSupplies . . . . . . . . . . . . . . . 224GET /powerSupplies . . . . . . . . . . . 224

/powerSupplies/ . . . . . . . . . . . 226GET /powerSupplies/ . . . . . . . 226

/scalableComplex . . . . . . . . . . . . . . 230GET /scalableComplex . . . . . . . . . . 230

/scalableComplex/ . . . . . . . . . . 242GET /scalableComplex/ . . . . . . 242

/storage . . . . . . . . . . . . . . . . . . 254GET /storage . . . . . . . . . . . . . . 254

/storage/ . . . . . . . . . . . . . . 261GET /storage/ . . . . . . . . . 261PUT /storage/ . . . . . . . . . . 273

© Copyright Lenovo 2015, 2017 i

/storage// . . . . . . . . . 275PUT /storage// . . . . . 275

/switch . . . . . . . . . . . . . . . . . . 277GET /switch . . . . . . . . . . . . . . 277

/switch/. . . . . . . . . . . . . . . 281GET /switch/ . . . . . . . . . . . 281PUT /switch/ . . . . . . . . . . . 290

/switches . . . . . . . . . . . . . . . . . 294GET /switches . . . . . . . . . . . . . 295

/switches/ . . . . . . . . . . . . . . 298GET /switches/ . . . . . . . . 298PUT /switches/ . . . . . . . . . . 307

/switches//ports . . . . . . . . . . . 312GET /switches//ports . . . . . . . 312PUT /switches//ports . . . . . . . 317

Chapter 5. Backup and restore resources . . . . . . . . . . . . . . . 321/switches/configurationData . . . . . . . . . . 321

GET /switches/configurationData . . . . . . 321PUT /switches/configurationData . . . . . . 323POST /switches/configurationData . . . . . 325

/switches//configurationData . . . . . . 327GET /switches//configurationData . . 327

/switches/configurationData/ . . . . . . 329GET /switches/configurationData/. . . . . . . . . . . . . . . . . . 329DELETE /switches/configurationData/. . . . . . . . . . . . . . . . . . 330

Chapter 6. Configuration Patterns resources . . . . . . . . . . . . . . . 331/config/target/ . . . . . . . . . . . . . 331

GET /config/target/ . . . . . . . . . . 331/patterns . . . . . . . . . . . . . . . . . 335

GET /patterns . . . . . . . . . . . . . . 335POST /patterns . . . . . . . . . . . . . 336

/patterns/ . . . . . . . . . . . . . . . 362GET /patterns/. . . . . . . . . . . . 362POST /patterns/ . . . . . . . . . . . 364

/patterns//includeSettings . . . . . . . . . 367GET /patterns//includeSettings . . . . . 367

/profiles . . . . . . . . . . . . . . . . . . 376GET /profiles . . . . . . . . . . . . . . 376

/profiles/ . . . . . . . . . . . . . . . . 378GET /profiles/ . . . . . . . . . . . . 378PUT /profiles/ . . . . . . . . . . . . 380POST /profiles/ . . . . . . . . . . . 381DELETE /profiles/ . . . . . . . . . . 382

/profiles/unassign/ . . . . . . . . . . . . 383POST /profiles/unassign/ . . . . . . . 383

Chapter 7. Operating-system deployment resources . . . . . . . . . 387/hostPlatforms . . . . . . . . . . . . . . . 387

GET /hostPlatforms . . . . . . . . . . . 387PUT /hostPlatforms . . . . . . . . . . . 405

/osdeployment/globalSettings . . . . . . . . . 409GET /osdeployment/globalSettings . . . . . 409PUT /osdeployment/globalSettings . . . . . 412

/osImages . . . . . . . . . . . . . . . . . 415GET /osImages . . . . . . . . . . . . . 416POST /osImages . . . . . . . . . . . . 423

/osImages/ . . . . . . . . . . . . 425GET /osImages/ . . . . . . . . 426

/osImages/ . . . . . . . . . . . . . . . 426GET /osImages/ . . . . . . . . . . . 426PUT /osImages/ . . . . . . . . . . . 428POST /osImages/ . . . . . . . . . . 432DELETE /osImages/,,... . . . . 434

/osImages?jobId= . . . . . . . . . . 435POST /osImages?jobId= . . . . . . 435

/osImages/remoteFileServers . . . . . . . . . 438GET /osImages/remoteFileServers . . . . . 438POST /osImages/remoteFileServers . . . . . 440

/osImages/remoteFileServers/ . . . . . . . 442GET /osImages/remoteFileServers/ . . . 443DELETE /osImages/remoteFileServers/ . . . . . . . . . . . . . . . . . 444PUT /osImages/remoteFileServers/ . . . 445

Chapter 8. Firmware update resources . . . . . . . . . . . . . . . 449/compliancePolicies . . . . . . . . . . . . . 449

GET /compliancePolicies . . . . . . . . . 449DELETE /compliancePolicies . . . . . . . . 453

/compliancePolicies/applicableFirmware . . . . . 455GET /compliancePolicies/ applicableFirmware . . . . . . . . . . . 455

/compliancePolicies/compareResult. . . . . . . 457GET /compliancePolicies/compareResult . . . 457POST /compliancePolicies/compareResult . . 459

/compliancePolicies/persistedResult . . . . . . 461GET /compliancePolicies/persistedResult . . . 461

/updateRepositories/firmware . . . . . . . . . 468GET /updateRepositories/firmware . . . . . 468PUT /updateRepositories/firmware . . . . . 474

/updatableComponents . . . . . . . . . . . 477GET /updatableComponents . . . . . . . . 477PUT /updatableComponents . . . . . . . . 488

Chapter 9. Management-server update resources . . . . . . . . . . . 495

ii Lenovo XClarity Administrator REST API Guide

/managementServer/updates . . . . . . . . . 495GET /managementServer/updates. . . . . . 495PUT /managementServer/updates. . . . . . 498POST /managementServer/updates . . . . . 500

/managementServer/updates?action= import&jobid={id} . . . . . . . . . . . . . . 502

POST /managementServer/updates?action= import&jobid= . . . . . . . . . . 502

/managementServer/updates/ . . . . 504GET /managementServer/updates/. . . . . . . . . . . . . . . . . . 505DELETE /managementServer/updates/ . . . . . . . . . . . . . . . . 509

Chapter 10. Monitoring and event resources . . . . . . . . . . . . . . . 513Filtering events . . . . . . . . . . . . . . . 513/events . . . . . . . . . . . . . . . . . . 517

GET /events . . . . . . . . . . . . . . 517/events/audit . . . . . . . . . . . . . . . . 523

GET /events/audit . . . . . . . . . . . . 523/events/actions . . . . . . . . . . . . . . . 528

GET /events/actions . . . . . . . . . . . 528POST /events/actions . . . . . . . . . . 530

/events/actions/ . . . . . . . . 532DELETE /events/actions/ . . . 532GET /events/actions/ . . . . . 532

/events/activeAlerts . . . . . . . . . . . . . 534GET /events/activeAlerts . . . . . . . . . 534

/events/activeAlerts/. . . . . . . . . . 536GET /events/activeAlerts/ . . . . . . 536

/events/activeAlerts/status . . . . . . . . . . 539GET /events/activeAlerts/status. . . . . . . 539

/events/activeAlerts/status/ . . . . . . . 540GET /events/activeAlerts/status/ . . . 541

/events/activeAlerts/summary . . . . . . . . . 542GET /events/activeAlerts/summary . . . . . 542

/events/activeAlerts/summary/. . . . . . 544GET /events/activeAlerts/summary/ . . . . . . . . . . . . . . . . 544

/events/config . . . . . . . . . . . . . . . 545GET /events/config. . . . . . . . . . . . 545PUT /events/config. . . . . . . . . . . . 546

/events/csv/auditLog. . . . . . . . . . . . . 547GET /events/csv/auditLog . . . . . . . . . 547

/events/csv/eventLog . . . . . . . . . . . . 551GET /events/csv/eventLog. . . . . . . . . 552

/events/csv/eventsLogs . . . . . . . . . . . 556GET /events/csv/eventsLogs . . . . . . . . 556

/events/exclusionfilters . . . . . . . . . . . . 561GET /events/exclusionfilters . . . . . . . . 561

POST /events/exclusionfilters . . . . . . . 562PUT /events/exclusionfilters . . . . . . . . 564

/events/exclusionfilters/ . . . . . . . 565DELETE /events/exclusionfilters/ . . 565

/events/helptext/ . . . . . . 565GET /events/helptext/ . . . . . . . . . . . . . . . . 566

/events/monitors . . . . . . . . . . . . . . 566GET /events/monitors . . . . . . . . . . 567POST /events/monitors . . . . . . . . . . 570PUT /events/monitors . . . . . . . . . . 574

/events/monitors/ . . . . . . . . . 575PUT /events/monitors . . . . . 575DELETE /events/monitors/ . . . 577

/events/notifications . . . . . . . . . . . . . 578GET /events/notifications . . . . . . . . . 578POST /events/notifications . . . . . . . . 582

/events/notifications/. . . . . . . 583GET /events/notifications/ . . . 583

/events/notifications// subscriptions . . . . . . . . . . . . . . . . 584

GET /events/notifications// subscriptions . . . . . . . . . . . . . . 584POST /events/notifications// subscriptions . . . . . . . . . . . . . . 588DELETE /events/notifications// subscriptions . . . . . . . . . . . . . . 591

/events/notifications// subscriptions/ . . . . . . . . 592

GET /events/notifications// subscriptions/ . . . . . . 592DELETE /events/notifications// subscriptions/ . . . . . . 595

/events/notifications// subscriptions//filters. . . . . . 596

GET /events/notifications// subscriptions//filters . . . . 596POST /events/notifications// subscriptions//filters . . . . 599DELETE /events/notifications// subscriptions//filters . . . . 601

/events/notifications// subscriptions//filters/ . . . . . . . . . . . . . . . . . . 602

GET /events/notifications// subscriptions//filters/ . . . . . . . . . . . . . . . . 602DELETE /events/notifications// subscriptions//filters/. . . . . . . . . . . . . . . . . . 604

/events/notifications/subscriptions . . . . . . . 605GET /events/notifications/subscriptions . . . 605PUT /events/notifications/subscriptions . . . 609

© Copyright Lenovo 2015, 2017 iii

DELETE /events/notifications/ subscriptions . . . . . . . . . . . . . . 611

/events/notifications/subscriptions/ . . . . . . . . . . . . . . . . . . . . 612

GET /events/notifications/subscriptions/ . . . . . . . . . . . . 612DELETE /events/notifications/subscriptions/ . . . . . . . . . . . . 615

/events/notifications/subscriptions//filters . . . . . . . . . . . . . . . . . 616

GET /events/notifications/subscriptions/ /filters . . . . . . . . . 616PUT /events/notifications/subscriptions/ /filters . . . . . . . . . 618DELETE /events/notifications/subscriptions/ /filters . . . . . . . . . 620

/events/notifications/subscriptions//filters/ . . . . . . . . . . . 621

GET /events/notifications/subscriptions/ /filters/ . . . . 621DELETE /events/notifications/subscriptions/ /filters/ . . . . . 623

/events/predefinedFilters . . . . . . . . . . . 624GET /events/predefinedFilters . . . . . . . 624PUT /events/predefinedFilters . . . . . . . 626POST /events/predefinedFilters . . . . . . . 628DELETE /events/predefinedFilters . . . . . . 630

/events/predefinedFilters/ . . . . . . 630DELETE /events/predefinedFilters/. . . . . . . . . . . . . . . . . . 630

/events/snmp/mib . . . . . . . . . . . . . . 631GET /events/snmp/mib . . . . . . . . . . 631

Chapter 11. Job management resources . . . . . . . . . . . . . . . 633/tasks. . . . . . . . . . . . . . . . . . . 633

GET /tasks . . . . . . . . . . . . . . . 633PUT /tasks . . . . . . . . . . . . . . . 641

/tasks/ . . . . . . . . . . . . . . 642GET /tasks/ . . . . . . . . . . . 642PUT /tasks/ . . . . . . . . . . . 650DELETE /tasks/ . . . . . . . . . 652

/tasks/detail . . . . . . . . . . . . . . . . 653GET /tasks/detail . . . . . . . . . . . . 653

/actions . . . . . . . . . . . . . . . . . . 659GET /actions . . . . . . . . . . . . . . 660

/actions/ . . . . . . . . . . . . . . 663GET /actions/ . . . . . . . . . . 663

/jobs . . . . . . . . . . . . . . . . . . . 666GET /jobs . . . . . . . . . . . . . . . 666

/jobs/ . . . . . . . . . . . . . . . 672GET /jobs/ . . . . . . . . . . . 672DELETE /jobs/ . . . . . . . . . . 679

PUT /jobs/ . . . . . . . . . . . 680/jobs/lock . . . . . . . . . . . . . . . . . 681

GET /jobs/lock . . . . . . . . . . . . . 681

Chapter 12. Security resources . . . . 683/certificateRevocationList . . . . . . . . . . . 683

GET /certificateRevocationList . . . . . . . 683POST /certificateRevocationList . . . . . . 685

/certificateRevocationList/ . . . . . . 686GET /certificateRevocationList/CRL_id> . . . 686DELETE /certificateRevocationList/ . . . . . . . . . . . . . . . . . . 688

/certificateSettings . . . . . . . . . . . . . 689GET /certificateSettings . . . . . . . . . . 689

/certificateSigningRequest . . . . . . . . . . 691GET /certificateSigningRequest . . . . . . . 691POST /certificateSigningRequest . . . . . . 693DELETE /certificateSigningRequest . . . . . 695

/cryptoSettings . . . . . . . . . . . . . . . 697GET /cryptoSettings . . . . . . . . . . . 697PUT /cryptoSettings . . . . . . . . . . . 699

/cryptoSettings/jobs . . . . . . . . . . . . . 703GET /cryptoSettings/jobs . . . . . . . . . 703

/cryptoSettings/jobs/ . . . . . . . . . 708GET /cryptoSettings/jobs/ . . . . . 708

/encapsulationSettings . . . . . . . . . . . . 713GET /encapsulationSettings . . . . . . . . 714PUT /encapsulationSettings . . . . . . . . 715

/endpoint/signingCertificate// . . . 716GET /endpoint/signingCertificate// . . . . . . . . . . . . . . . 716PUT /endpoint/signingCertificate// . . . . . . . . . . . . . . . 720

/ldapClientSettings . . . . . . . . . . . . . 722GET /ldapClientSettings. . . . . . . . . . 723PUT /ldapClientSettings. . . . . . . . . . 726

/roles . . . . . . . . . . . . . . . . . . . 731GET /roles . . . . . . . . . . . . . . . 731

/roles/ . . . . . . . . . . . . . . . 733GET /roles/ . . . . . . . . . . . 733

/roleGroups . . . . . . . . . . . . . . . . 735GET /roleGroups . . . . . . . . . . . . 735POST /roleGroups . . . . . . . . . . . . 738

/roleGroups/ . . . . . . . . . . . . . . 741PUT /roleGroups/ . . . . . . . . . . 741

/roleGroups/ . . . . . . . . . . . . . 742GET /roleGroups/ . . . . . . . . . 742DELETE /roleGroups/ . . . . . . . 745

/ssoSettings . . . . . . . . . . . . . . . . 746GET /ssoSettings . . . . . . . . . . . . 747PUT /ssoSettings . . . . . . . . . . . . 748

iv Lenovo XClarity Administrator REST API Guide

/serverCertificate . . . . . . . . . . . . . . 750GET /serverCertificate . . . . . . . . . . 751POST /serverCertificate . . . . . . . . . . 752PUT /serverCertificate . . . . . . . . . . 756

/serverCertificate/details . . . . . . . . . . . 758GET /serverCertificate/details . . . . . . . 758

/serverCertificate/jobs . . . . . . . . . . . . 761GET /serverCertificate/jobs . . . . . . . . 761

/serverCertificate/jobs/ . . . . . . . . 765GET /serverCertificate/jobs/. . . . . 765

/sessions . . . . . . . . . . . . . . . . . 768GET /sessions . . . . . . . . . . . . . 768POST /sessions . . . . . . . . . . . . . 770DELETE /sessions . . . . . . . . . . . . 771

/sessions/ . . . . . . . . . . . . . . 772DELETE /sessions/ . . . . . . . . 772

/signingCertificate . . . . . . . . . . . . . . 774GET /signingCertificate . . . . . . . . . . 774PUT /signingCertificate . . . . . . . . . . 775

/signingCertificate/details . . . . . . . . . . . 777GET /signingCertificate/details . . . . . . . 777

/signingCertificate/jobs . . . . . . . . . . . . 779GET /signingCertificate/jobs . . . . . . . . 779

/signingCertificate/jobs/ . . . . . . . . 782GET /signingCertificate/jobs/ . . . . 782

/storedCredentials. . . . . . . . . . . . . . 786GET /storedCredentials . . . . . . . . . . 786POST /storedCredentials . . . . . . . . . 787

/storedCredentials/ . . . . . . . . . . . 788GET /storedCredentials/ . . . . . . . . 789PUT /storedCredentials/ . . . . . . . . 790DELETE /storedCredentials/ . . . . . . 792

/trustedCertificates . . . . . . . . . . . . . 792GET /trustedCertificates. . . . . . . . . . 793POST /trustedCertificates . . . . . . . . . 794

/trustedCertificates/ . . . . . . . . . . . 796GET /trustedCertificates/ . . . . . . . 796DELETE /trustedCertificates/ . . . . . . 797

/trustedCertificates/details . . . . . . . . . . 799GET /trustedCertificates/details . . . . . . . 799

/trustedCertificates/details/ . . . . . . . . 801GET /trustedCertificates/details/ . . . . 801

/userAccounts . . . . . . . . . . . . . . . 803GET /userAccounts . . . . . . . . . . . 803POST /userAccounts . . . . . . . . . . . 806

/userAccounts/ . . . . . . . . . . . . . 811GET /userAccounts/ . . . . . . . . . 811PUT /userAccounts/ . . . . . . . . . 814DELETE /userAccounts/ . . . . . . . . 816

/userAccounts/passwordChange . . . . . . . . 817

PUT /userAccounts/passwordChange . . . . 817/userAccountSettings . . . . . . . . . . . . 819

GET /userAccountSettings. . . . . . . . . 819PUT /userAccountSettings. . . . . . . . . 821

Chapter 13. Service and support resources . . . . . . . . . . . . . . . 827/callhome/endpoints . . . . . . . . . . . . . 827

GET /callhome/endpoints . . . . . . . . . 827/callhome/endPointContact/ . . . . . . 828

GET /callhome/endPointContact/ . . . 828POST /callhome/endPointContact/ . . . . . . . . . . . . . . . . 829DELETE /callhome/endPointContact/ . . . . . . . . . . . . . . . . 830

/callhome/endPointsPMR . . . . . . . . . . . 831GET /callhome/endPointsPMR . . . . . . . 831DELETE /callhome/endPointsPMR . . . . . 832

/callhome/endPointsPMR/ . . . . . . 834GET /callhome/endPointsPMR/ . . . . . . . . . . . . . . . . . 834

/callhome/endPointsPMRStatus . . . . . . . . 835GET /callhome/endPointsPMRStatus . . . . 835

/callhome/endPoints/list . . . . . . . . . . . 839GET /callhome/endPoints/list. . . . . . . . 840

/callhome/pmrattach/ . . . . . . . . 841POST /callhome/pmrattach/ . . . . 841

/ffdc/endpoint/ . . . . . . . . . . . . 842GET /ffdc/endpoint/ . . . . . . . . 842

/service/forwarders/settings . . . . . . . . . . 844GET /service/forwarders/settings . . . . . . 844PUT /service/forwarders/settings . . . . . . 845

/warranty . . . . . . . . . . . . . . . . . 846GET /warranty . . . . . . . . . . . . . 846PUT /warranty . . . . . . . . . . . . . 847

Chapter 14. Energy metrics . . . . . . 849/canisters/metrics . . . . . . . . . . . . . . 849

GET /canisters/metrics . . . . . . . . . . 849/canisters/metrics/ . . . . . . . . . . 853

GET /canisters/metrics/ . . . . . . 853/chassis/metrics . . . . . . . . . . . . . . 857

GET /chassis/metrics . . . . . . . . . . . 857/chassis/metrics/ . . . . . . . . . . . 860

GET /chassis/metrics/ . . . . . . . 861/fans/metrics . . . . . . . . . . . . . . . . 864

GET /fans/metrics . . . . . . . . . . . . 865/fans/metrics/ . . . . . . . . . . . . 866

GET /fans/metrics/ . . . . . . . . 866/nodes/metrics . . . . . . . . . . . . . . . 868

GET /nodes/metrics . . . . . . . . . . . 869

© Copyright Lenovo 2015, 2017 v

/nodes/metrics/ . . . . . . . . . . . 876GET /nodes/metrics/ . . . . . . . . 876

/powerSupplies/metrics . . . . . . . . . . . 882GET /powerSupplies/metrics . . . . . . . . 882

/powerSupplies/metrics/ . . . . . . . . 884GET /powerSupplies/metrics/ . . . . 884

/switch/metrics . . . . . . . . . . . . . . . 887GET /switch/metrics . . . . . . . . . . . 887

/switch/metrics/ . . . . . . . . . . . 889GET /switch/metrics/. . . . . . . . 889

/switches/metrics . . . . . . . . . . . . . . 891GET /switches/metrics . . . . . . . . . . 891

/switches/metrics/ . . . . . . . . . . 893GET /switches/metrics/ . . . . . . . 893

Index . . . . . . . . . . . . . . . . . . 897

vi Lenovo XClarity Administrator REST API Guide

Summary of changes in the REST API

The following REST APIs were added or updated in follow-on releases of Lenovo XClarity Administrator.

Version 1.4.0

This version supports the following enhancements to the Open REST API.

• Virtual appliance management resources

– “GET /aicc” on page 5. Added the preferredDisplayName response parameter to specify the property to use to display the device names in the user interface.

– “PUT /aicc” on page 10. Added the preferredDisplayName request parameter to specify the property to use to display the device names in the user interface.

• Discovery resources

– “GET /discovery” on page 43. Added the securityDescriptor response parameter to specify information about the authentication enablement and associated stored credentials for a managed device.

– “GET /discoverRequest/jobs/” on page 53. Added the securityDescriptor response parameter to specify information about the authentication enablement and associated stored credentials for a managed device.

– “POST /manageRequest” on page 61. Added the securityDescriptor request parameter to specify information about the authentication enablement and associated stored credentials for a managed device.

• Inventory resources

– “GET /canisters” on page 75 and “GET /canisters/” on page 79 . The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /chassis” on page 91 and “GET /chassis/” on page 107. Added the securityDescriptor response parameter to return information about the authentication enablement and associated stored credentials for a managed device. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /cmms” on page 136 and “GET /cmms/” on page 139. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /fans” on page 150 and “GET /fans/” on page 152. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /fanMuxes” on page 156 and “GET /fanMuxes/” on page 158. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /nodes” on page 161 and “GET /nodes/” on page 177. Added the securityDescriptor response parameter to return information about the authentication enablement and associated stored credentials for a managed device. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method. Added the firmware response parameter under raidSettings to return firmware information for M.2 and NVMe disks.

– “PUT /nodes/” on page 214. Added the securityDescriptor request parameter to set information about the authentication enablement and associated stored credentials for a managed device.

– “GET /powerSupplies” on page 224 and “GET /powerSupplies/” on page 226. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

© Copyright Lenovo 2015, 2017 vii

– “GET /storage” on page 254 and “GET /storage/” on page 261. The value of the name response parameter is determined by the preferredDisplayName parameter in the /aicc method.

– “GET /switches” on page 295 and “GET /switches/” on page 298. The value of the name response parameter is determined by preferredDisplayName parameter in the /aicc method.

– (NEW) “GET /switches//ports” on page 312. Starts a job to retrieve port information for a specific RackSwitch or Flex System switch.

– (NEW) “PUT /switches//ports” on page 317. Enables or disables ports for a specific RackSwitch or Flex System switch.

• Backup and restore resources

– (NEW) “GET /switches/configurationData” on page 321. Retrieves information about all configurationdata files for all managed RackSwtich and Flex System switches.

– (NEW) “PUT /switches/configurationData” on page 323. Restores configuration data for one or more RackSwitch or Flex System switches.

– (NEW) “POST /switches/configurationData” on page 325. Imports a switch configuration-data file from the local system into Lenovo XClarity Administrator or backs up configuration data for one or more RackSwitch or Flex System switches.

– (NEW) “GET /switches//configurationData” on page 327. Retrieves information about all configuration-data files in Lenovo XClarity Administrator for a specific RackSwtich or Flex System switch.

– (NEW) “GET /switches/configurationData/” on page 329. Downloads (exports) one or more switch configuration-data files to the local system.

– (NEW) “DELETE /switches/configurationData/” on page 330. Deletes one or more switch configuration-data files from Lenovo XClarity Administrator.

• Monitoring and event resources

– “GET /events” on page 517. Added the componentIdentifierText response parameter to specify the component description.

• Jobs resources

– “PUT /tasks/” on page 650. Added the cancelRESTBody, cancelRESTMethod, cancelURL, and expirationTimeOut request parameters to cancel callback to a created job.

– “GET /jobs” on page 666. Added the summary response parameter to specify information about the job summary.

– “GET /jobs/” on page 672. Added the summary response parameter to specify information about the job summary.

• Security resources

– (New) “GET /storedCredentials” on page 786. Retrieves information about all stored credentials.

– (New) “POST /storedCredentials” on page 787. Creates a stored credential.

– (New) “GET /storedCredentials/” on page 789. Retrieves information about a specific stored credential.

– (New) “PUT /storedCredentials/” on page 790. Modifies properties for a specific stored credential.

– (New) “DELETE /storedCredentials/” on page 792. Deletes a specific stored credential.

• Service and support resources

– (New) “GET /service/forwarders/settings” on page 844. Retrieves information about whether service data is forwarded to the preferred service provider when a serviceable event that is on the list of excluded events occurs.

viii Lenovo XClarity Administrator REST API Guide

– (New) “PUT /service/forwarders/settings” on page 845. Enables or disables forwarding service data to the preferred service provider when a serviceable event that is on the list of excluded events occurs.

Version 1.3.2

The are no enhancements to the Open REST API in this version.

Version 1.3.1

This version supports the following enhancements to the Open REST API.

• Inventory resources

– “GET /nodes” on page 161 and “GET /nodes/” on page 177. Added the FeaturesOnDemand response parameter to return information about tier levels and features. Added the m2Presence response parameters to return information about whether the node contains M.2 storage.

Note: Support for Flex System storage devices will be deprecated from these APIs at a future date. Use the “GET /storage” on page 254 method instead.

• Operating-system deployment resources

– “GET /hostPlatforms” on page 387. Added the mgmtProcType response parameter to identify the type of baseboard management controller in the node. Add the remoteControl response parameter to indicate the remote control enablement status. Added “M.2drives” as a new value for the storageSetting > label and the storageSetting > value response parameters to support deploying operating systems on M.2 drives.

– “PUT /hostPlatforms” on page 405. Added “M.2drives” as a new value for the storageSetting targetDevice request parameter to support deploying operating systems on M.2 drives. Added the windowsDomainBlob to specify the Active Directory Computer Account Metadata (in Base-64 encoded blob format) that can be used to join the Active Directory domain for any Windows operating system.

• Firmware update resources

– “PUT /updateRepositories/firmware” on page 474. Added the filetypes=all query parameter to delete the selected update packages (payload, change history, readme, and metadata files) instead of only the payload (image) files.

• Security resources

– “GET /ldapClientSettings” on page 723. Added the useServersAsGlobalCatalogs response parameter to indicate whether domain controllers are treated as global catalogs

– “PUT /ldapClientSettings” on page 726. Added the useServersAsGlobalCatalogs request parameter to specify whether to treat domain controllers as global catalogs.

Version 1.3.0

This version supports the following enhancements to the Open REST API.• The following methods were added or updated:

– Discovery resources– “POST /manageRequest” on page 61. Supports specifying a fully-qualified domain name in the

ipAddresses request parameter.– Inventory resources

– “GET /nodes” on page 161 and “GET /nodes/” on page 177. Added the FeaturesOnDemand response parameter to return information about tier levels and features.

– (New) “PUT /nodes//bmc” on page 222. Restarts the baseboard management controller for a specific managed server.

© Copyright Lenovo 2015, 2017 ix

– “GET /switches” on page 295 and “GET /switches/” on page 298. Added the OS response parameter to return information about the operating system that is installed on the RackSwitch switch (ENOS or CNOS).

– “GET /switches/” on page 298. Added the ntp response parameter to identify the NTP settings .

– Monitoring and event resources– (New) “GET /events/notifications” on page 578. Retrieves configuration and subscription

information for all push notification services.– (New) “POST /events/notifications” on page 582. Generates a test event that pushes to a specific

push notification service or subscription.– (New) “GET /events/notifications/” on page 583. Retrieves information about a

specific push notification service.– (New) “GET /events/notifications//subscriptions” on page 584. Retrieves information

about all subscriptions for a specific push notification service.– (New) “POST /events/notifications//subscriptions” on page 588. Modifies a

subscription that is used to forward events to mobile devices or WebSocket service.– (New) “DELETE /events/notifications//subscriptions” on page 591. Deletes all

subscriptions for a specific push notification service.– (New) “GET /events/notifications//subscriptions/” on page 592.

Retrieves information about a specific subscription for a specific push notification service.– (New) “DELETE /events/notifications//subscriptions/” on page 595.

Deletes a specific subscription.– (New) “GET /events/notifications//subscriptions//filters” on page

596. Retrieves information about all event filters that are associated with a specific push notification service.

– (New) “POST /events/notifications//subscriptions//filters” on page 599. Creates an event filter for a specific subscription.

– (New) “DELETE /events/notifications//subscriptions//filters” on page 601. Deletes all event filters for a specific subscription.

– (New) “GET /events/notifications//subscriptions//filters/” on page 602. Retrieves information about a specific event filter that is associated with a specific subscription.

– “DELETE /events/notifications//subscriptions//filters/” on page 604. Deletes one or more event filters from a specific subscription.

– (New) “GET /events/notifications/subscriptions” on page 605. Retrieve information about all subscriptions.

– (New) “DELETE /events/notifications/subscriptions” on page 611. Deletes all subscriptions for all push notification services.

– (New) “GET /events/notifications/subscriptions/” on page 612. Retrieves information about a specific subscription.

– (New) “DELETE /events/notifications/subscriptions/” on page 615. Deletes a specific subscription.

– (New) “GET /events/notifications/subscriptions//filters” on page 616. Retrieves information about all event filters that are associated with a specific subscription.

– (New) “DELETE /events/notifications/subscriptions//filters” on page 620. Deletes all event filters for a specific subscription.

– (New) “GET /events/notifications/subscriptions//filters/” on page 621. Retrieves information about a specific event filter that is associated with a specific subscription .

– (New) “DELETE /events/notifications/subscriptions//filters/” on page 623. Deletes one or more event filters from a specific subscription.

– (New) “POST /events/predefinedFilters” on page 628. Creates a predefined event filter.– (New) “DELETE /events/predefinedFilters” on page 630. Deletes all predefined event filters.– (New) “DELETE /events/predefinedFilters/” on page 630. Deletes one or more predefined

event filters.

x Lenovo XClarity Administrator REST API Guide

– (New) “GET /events/snmp/mib” on page 631. Download the management information base (MIB) file, whicih describes the SNMP traps that Lenovo XClarity Administrator generates.

– Job management resources– “GET /tasks” on page 633. Added the following states to the stateIconKey and status response

parameters: Complete_With_Errors, Unknown, Uploading, and Validating.– (New) “GET /tasks/” on page 642. Retrieves information about one or more jobs (tasks).

You can specify multiple job IDs, separated by a comma, in the URL.– (New) “PUT /tasks/” on page 650. Cancels one or more jobs (tasks). You can specify

multiple job IDs, separated by a comma, in the URL.– “DELETE /tasks/” on page 652. Deletes one or more jobs (tasks). You can specify

multiple job IDs, separated by a comma, in the URL.– Configuration Pattern resources

– (New) “PUT /profiles/” on page 380. Modifies the name of an existing server profile.– Operating-system deployment resources

– “GET /hostPlatforms” on page 387. Added the mgmtProcType response parameter to identify the type of baseboard management controller in the node. Add the remoteControl response parameter to indicate the remote control enablement status.

– “GET /osdeployment/globalSettings” on page 409. Added the “staticv6” as a new value for the ipAssignment response parameter to support static IPv6 addresses for the host network setting option for OS deployment.

– “PUT /osdeployment/globalSettings” on page 412. Added the “staticv6” as a new value for the ipAssignment response parameter to support static IPv6 addresses for the host network setting option for OS deployment.

– “GET /osImages” on page 416. Added the lastRefreshed, response parameter to return the timestamp of the last predefined OS-image repository refresh. Added the bootFiles, driverFiles, customizationOptions, and unattendFiles response parameters to return information about custom OS image profiles. Added the bootFileDiskUsage response parameter to return information about the disk space that is used by the boot files (such as WinPE).

Attention: The drivers response body parameter and its child parameters are deprecated in this release.

– “POST /osImages” on page 423. Changed the fileSize request parameter to be required. Added the imageType=DUD query parameter to import a device driver. Added the imageType=BOOT query parameter to import a boot-options file (such as a Windows .WIM file). Added the imageType=OSPROFILE query parameter to import a customized OS image profile.

– (New) “GET /osImages/” on page 426. Exports (downloads) a customized OS-image profile to a remote image server or local system.

– (New) “GET /osImages/” on page 426. Creates a downloadable tar.gz file that contains a customized OS-image profile.

– (New) “PUT /osImages/” on page 428. Modifies a base operating system or customized OS image profile.

– (New) “POST /osImages/” on page 432. Creates a customized OS-image profile from a base operating system.

– “DELETE /osImages/,,...” on page 434. Supports removing boot-option files, device drivers, and customized OS-image profiles

– “POST /osImages?jobId=” on page 435. Added the imageType=DUD query parameter to import a device driver. Added the imageType=BOOT query parameter to import a boot-options file (such as a Windows .WIM file). Added the imageType=OSPROFILE query parameter to import a customized OS-image profile.

Attention: The imageName query parameter is deprecated in this release.– (New) “GET /osImages/remoteFileServers” on page 438. Retrieves information about all remote file-

server profiles.– (New) “POST /osImages/remoteFileServers” on page 440. Creates or modifies a remote file-server

profile.

© Copyright Lenovo 2015, 2017 xi

– (New) “GET /osImages/remoteFileServers/” on page 443. Retrieves information about a specific remote file-server profile.

– (New) “DELETE /osImages/remoteFileServers/” on page 444. Deletes a specific remote file- server profile.

– Firmware update resources:– “POST /compliancePolicies/compareResult” on page 459. The “xITE” value for the type request

parameter is deprecated. Use “Server” instead.– “GET /compliancePolicies/persistedResult” on page 461. The “xITE” value for the type query

parameter is deprecated. Use “Server” instead.– “PUT /updatableComponents” on page 488. Added the action=powerState query parameter to

modify the power state for a device, and the powerState request parameter to specify which power operation to perform.

– “GET /updateRepositories/firmware” on page 468. Added the key=isUpdating query parameter and isUpdating response parameter to return the whether the firmware repository is being updated.

– Security resources– “GET /cryptoSettings” on page 697. Added the minTlsVersionClient response parameter to set

the minimum TLS protocol version to use for client connections to other servers (such as the LDAP client). Added the minTlsVersionOsDeployquery response parameter to set the minimum TLS protocol version for the Lenovo XClarity Administrator OS deployment server. Added the minTlsVersionServer response parameter to set the minimum TLS protocol version to use for server connections to other servers (such as the web server).

The cipherSuite response parameter will be deprecated in a future release.

The “nist800-131a-flexcat” value for the nistMode response parameter will be deprecated in a future release.

– “PUT /cryptoSettings” on page 699. Added the minTlsVersionClient request parameter to set the minimum TLS protocol version to use for client connections to other servers (such as the LDAP client). Added the minTlsVersionOsDeployqueryrequest parameter to set the minimum TLS protocol version to for the Lenovo XClarity Administrator OS deployment server. Added the minTlsVersionServer request parameter to set the minimum TLS protocol version to use for server connections to other servers (such as the web server).

Attention:

• The cipherSuite request parameter will be deprecated in a future release.

• The “nist800-131a-flexcat” value for the nistMode request parameter will be deprecated in a future release.

– Service and support resources– (New) “GET /warranty” on page 846. Refreshes the warranty information on the management server.– (New) “PUT /warranty” on page 847. Downloads the warranty data as a .JSON or .CSV file.

Version 1.2.2

This version supports the following enhancements to the Open REST API.• The following REST APIs were added or updated:

– Operating-system deployment resources– “GET /osImages” on page 416. Added the diskUsage response parameter to return the space that

is used by the operating-system image, device drivers, and boot files. – Inventory resources

– “GET /nodes/” on page 177. Added physicalPorts object under the portInfo response parameter, which provides firmware information for about the physical ports. Added logicalPortIndex and physicalPortIndex integers under the physicalPorts response parameter, which provides the number of logical and physical ports.

– Management-server update resources– (New) “GET /managementServer/updates” on page 495. Retrieves information about all updates in

the management-server updates repository.

xii Lenovo XClarity Administrator REST API Guide

– (New) “PUT /managementServer/updates” on page 498. Installs an update to the management server.

– (New) “POST /managementServer/updates” on page 500. Manages management-server updates in the updates repository.

– (New) “GET /managementServer/updates/” on page 505. Retrieves information or the readme or change history file for a specific update in the management-server updates repository.

– (New) “DELETE /managementServer/updates/” on page 509. Deletes update packages and metadata from the management-server updates repository.

Version 1.2.1


Version 1.2.0

This version supports the following enhancements to the Open REST API.• The following methods were added or updated:

– Discovery resources– (New) “POST /csvRequest” on page 33. Manages devices using a bulk-import CSV file.– (New) “GET /discovery” on page 43. Retrieves a list of devices discovered by SLP discovery.

– Inventory resources– (New) “GET /storage” on page 254. Retrieves properties for all Lenovo Storage and Flex System

storage devices.– (New) “GET /storage/” on page 261. Retrieves properties for a specific Lenovo Storage

or System storage devices.– (New) “PUT /storage/” on page 273. Modifies properties or performs management actions

on a specific the Lenovo Storage and System storage devices.– (New) “PUT /storage//” on page 275. Powers on or off a specific Lenovo

Storage and Flex storage controller.– (New) “GET /switches//ports” on page 312. Retrieves port information for a specific

RackSwitch or Flex switch.– Configuration Patterns resources

– “POST /profiles/unassign/” on page 383. Added the force request parameter under items to force profile deactivation.

– Firmware update resources:– “DELETE /compliancePolicies” on page 453. Add the removePackage request parameter to

delete the firmware-update packages that are associated with the specified compliance policies if the packages are not associated with another compliance policy.

– (New) “GET /compliancePolicies/applicableFirmware ” on page 455. Retrieves information about firmware that is applicable to each managed device.

– GET /updateRepositories/firmware. Added the “export” value to the key query parameter to return a ZIP file that contains the firmware-compliance policy, added the exportRepoFilename query parameter to specify the name of the ZIP file, and added the supportDownload response parameter to indicate whether the update is downloaded form the Lenovo Support website.

– PUT /updateRepositories/firmware. Added the export value to the key query parameter to return a ZIP file that contains the firmware-compliance policy.

– GET /updatableComponents. Added the query query parameter to identify whether to return a list of devices and components that can be updated or the status and progress of firmware updates, and added the storageList and switchList response parameters.

– PUT /updatableComponents. Added the Component Fixid request parameter to specify the ID of the target package to be applied to the CMM, server, and switch, and added the storageList request parameter to identify switches to act upon

– Monitoring and event resources:– GET /events/monitors. Added SNMPv1 as another value for the protocol field. Added the

communicationProtocol response field to identify the type of protocol that the syslog monitor uses to send messages. Added the community response field to define the community password that is

© Copyright Lenovo 2015, 2017 xiii

sent with every SNMPv1 request to the device. Added the version response field to define the SNMP version.

– POST /events/monitors. Added SNMPv1 as another value for the protocol field. Added the communicationProtocol response field to identify the type of protocol that the syslog monitor uses to send messages. Added the community response field to define the community password that is sent with every SNMPv1 request to the device. Added the version response field to define the SNMP version.

– PUT /events/monitors. Added SNMPv1 as another value for the protocol field. Added the communicationProtocol response field to identify the type of protocol that the syslog monitor uses to send messages. Added the community response field to define the community password that is sent with every SNMPv1 request to the device. Added the version response field to define the SNMP version.

– Job management resources:– (New) GET /tasks. Retrieves information about all jobs (tasks) and their subtasks.– (New) GET /tasks/{UID}. Retrieves information about all jobs (tasks) and their subtasks.– (New) PUT /tasks. Cancels a job (task).– (New) DELETE /tasks/{UID}. Deletes a specific job (task).

– Security resources:– (New) GET /deviceTrustedCertificates. Retrieve information about the trusted certificates that are

currently installed on managed devices.– (New) DELETE /deviceTrustedCertificates. Deletes a trusted certificates that are currently installed

on managed devices.– GET /ldapClientSettings. Added more response fields, including bindingMethod,

groupSearchAttribName, and userSearchAttribName. Added new values for userAuthenticationMethod, including ldap_local and local_ldap.

– PUT /ldapClientSettings. Added more request fields, including bindingMethod, groupSearchAttribName, and userSearchAttribName. Added new values for the userAuthenticationMethod field, including ldap_local and local_ldap.

– GET /roleGroups. Added lxc-recovery as a new value for the roles field.– POST /roleGroups. Added lxc-recovery as a new value for the roles field.– GET /roleGroups/{name}. Added lxc-recovery as a new value for the roles field.– POST /serverCertificate. After uploading the new signed server certificate, this method provisions

the certificate to all managed devices. The jobPath response field is returned with the URI of the created job.

– (New) GET /serverCertificate/jobs. Retrieves information about all known jobs for provisioning signed server certificates to all managed devices.

– (New) GET /serverCertificate/jobs/{job_ID}. Retrieves information about a specific job for provisioning a signed server certificates to all managed devices.

– GET /sessions. Added more response fields, including authenticationServer, created, id, idleFor, and lastAccessed.

– (New) DELETE /sessions/{UUID}. Logs off (disconnects) an active user session from Lenovo XClarity Administrator.

– POST /signedCertificate. After uploading the new CA root certificate, this method provisions the certificate to all managed devices. The jobPath response field is returned with the URI of the created job.

– (New) GET /signingCertificate/jobs. Retrieves information about all known jobs for provisioning signing certificates to managed devices.

– (New) GET /signingCertificate/jobs/{job_ID}. Retrieves information about a specific job for provisioning a signing certificate to managed devices.

– Service and support resources:– GET /ffdc/device/{UUID}. Added support for collect and export the first failure data capture (FFDC)

data for a specific storage device.• The following APIs will be deprecated in a future release:

– /actions– /actions/{job_ID}

xiv Lenovo XClarity Administrator REST API Guide

– /jobs– /jobs/{job_ID}– /jobs/lock– /jobs/lock/{job_ID}

Version 1.1.1


Version 1.1.0

This version supports the following enhancements to the Open REST API.• The following methods were added:

– GET /ssoSettings. Returns information about the client settings when an external SAML 2.0 identity provider is used for authentication.

– PUT /ssoSettings. Modifies the client settings when an external SAML 2.0 identity provider is used for authentication.

• The following methods were updated: – GET /chassis. Added the formatType query parameter to return information in JSON, CSV, or XML

types. Returns the encapsulation object with information about firewall settings.– GET /chassis/{UUID},{UUID},...{UUID}. Accepts more than one UUID in the request URL. Added the

formatType query parameter to return information in JSON or CSV types. Returns the encapsulation object with information about firewall settings.

– PUT /chassis/{UUID}. Added the encapsulation request parameter to modify information about firewall settings.

– GET /nodes. Added the formatType query parameter to return information in JSON, CSV, or XML types. Returns the encapsulation object with information about firewall settings.

– GET /nodes/{UUID},{UUID},...{UUID}. Accepts more than one UUID in the request URL. Added the formatType query parameter to return information in JSON, CSV, or XML types. Returns the encapsulation object with information about firewall settings, and thinkServerFru objects and additional drive parameters for ThinkServer servers.

– PUT /nodes/{UUID}. Added the encapsulation request parameter to modify information about firewall settings.

– GET /switches. Added the formatTypequery parameter to return information in JSON, CSV, or XML types.

– GET /switches/{UUID},{UUID},...{UUID}. Accepts more than one UUID in the request URL. Added the formatTypequery parameter to return information in JSON, CSV, or XML types.

– GET /hostPlatforms. Returns the vlanId string with information about VLAN ID for operating-system VLAN tagging.

– PUT /hostPlatforms. Added the vlanId request parameter to modify VLAN ID for operating-system VLAN tagging.

– GET /osdeployment/globalSettings. Returns the isVLANMode string, which indicates whether VLAN mode is used.

– PUT /osdeployment/globalSettings. Added the isVLANMode request parameter to modify whether VLAN mode is used. Added ESXi and LINUX operating-system values for the type request parameter.

Version 1.0.3

The are no enhancements to the REST API in this version.

Version 1.0.2

This version supports the following enhancements to the REST API.• The following methods were added:

– GET /cryptoSettings/jobs– GET /cryptoSettings/jobs/{job_ID}

• The following methods were updated:

© Copyright Lenovo 2015, 2017 xv

– PUT /cryptoSettings. The optional returnJobInfo parameter in the request body of the PPUUTT //ccrryyppttooSSeettttiinnggss method indicates whether to return job information as a result of changing the cryptographic settings

Version 1.0.1

This version supports the following enhancements to the Open REST API.• The following methods were added:

– POST /config/profile/unassign/{id}– PUT /jobs/{job_ID}– POST /patterns– GET /patterns/{id}/includeSettings– GET /switches– GET /switches/{UUID},{UUID},...{UUID}– PUT /switches/{UUID}

• The singular form //sswwiittcchh and //sswwiittcchh//{{UUUUIIDD}} will be deprecated at a future date. Use the plural form //sswwiittcchheess and //sswwiittcchheess//{{UUUUIIDD}} instead.

xvi Lenovo XClarity Administrator REST API Guide

Chapter 1. Lenovo XClarity Administrator Overview

Lenovo XClarity Administrator is a centralized, resource-management solution that simplifies infrastructure management, speeds responses, and enhances the availability of Lenovo® server systems and solutions. It runs as a virtual appliance that automates discovery, inventory, tracking, monitoring, and provisioning for server, network, and storage hardware in a secure environment.

Lenovo XClarity Administrator provides a central interface to perform the following functions for all managed devices.

Hardware managementLenovo XClarity Administrator provides agent-free hardware management. It can automatically discover manageable devices, including server, network, and storage hardware. Inventory data is collected for managed devices for an at-a-glance view of the managed hardware inventory and status.

There are various management tasks for each supported device, including viewing status and properties, and configuring system and network settings, launching the management interfaces, powering on and off, and remote control. For more information about managing devices, see Managing chassis, Managing servers, and Managing switches in the Lenovo XClarity Administrator online documentation.

Tip: Server, network, and storage hardware that can be managed by Lenovo XClarity Administrator is referred to as devices. Hardware that is under Lenovo XClarity Administrator management is referred to as managed devices.

You can use the rack view in Lenovo XClarity Administrator to group your managed devices to reflect the physical rack setup in your datacenter. For more information about racks, see Managing racks in the Lenovo XClarity Administrator online documentation.

Hardware monitoringLenovo XClarity Administrator provides a centralized view of all events and alerts that are generated from the managed devices. An event or alert is passed to the Lenovo XClarity Administrator and is displayed in the events or alerts log. A summary of all events and alerts is visible from the Dashboard

© Copyright Lenovo 2015, 2017 1

http://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/chassis_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/chassis_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/server_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/switches_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/racks_manage.html

and the Status bar. Events and alerts for a specific device are available from the Alerts and Events detail page for that device.

For more information about monitoring hardware, see Working with events and Working with alerts in the Lenovo XClarity Administrator online documentation.

Operating-system deploymentYou can use Lenovo XClarity Administrator to manage a repository of operating-system images and to deploy operating-system images to up to 28 servers managed servers concurrently.

For more information about deploying operating systems, see Deploying an operating system image in the Lenovo XClarity Administrator online documentation.

Configuration managementYou can quickly provision and pre-provision all of your servers using a consistent configuration. Configuration settings (such as local storage, I/O adapters, boot settings, firmware, ports, and management controller and UEFI settings) are saved as a server pattern that can be applied to one or more managed servers. When the server patterns are updated, the changes are automatically deployed to the applied servers.

Server patterns also integrate support for virtualizing I/O addresses, so you can virtualize Flex System fabric connections or repurpose servers without disruption to the fabric.

For more information about configuring servers, see Configuring servers using the Lenovo XClarity Administrator in the Lenovo XClarity Administrator online documentation.

Firmware compliance and updatesFirmware management is simplified by assigning firmware-compliance policies to managed devices. When you create and assign a compliance policy to managed devices, Lenovo XClarity Administrator monitors changes to the inventory for those devices and flags any devices that are out of compliance.

When a device is out of compliance, you can use Lenovo XClarity Administrator to apply and activate firmware updates for all devices in that device from a repository of firmware updates that you manage.

Note: Refreshing the repository and downloading firmware updates requires an Internet connection. If Lenovo XClarity Administrator has no Internet connection, you can manually import firmware updates to the repository.

For more information about updating firmware, see Updating firmware on managed devices in the Lenovo XClarity Administrator online documentation.

User managementLenovo XClarity Administrator provides a centralized authentication server to create and manage user accounts and to manage and authenticate user credentials. The authentication server is created automatically when you start the management server for the first time. The user accounts that you create for Lenovo XClarity Administrator can also be used to log in to managed chassis and servers in managed-authentication mode. For more information about users, see Managing user accounts in the Lenovo XClarity Administrator online documentation.

Lenovo XClarity Administrator supports three types of authentication servers:

• Local authentication server. By default, Lenovo XClarity Administrator is configured to use the local authentication server that resides on the management node.

• External LDAP server. Currently, only Microsoft Active Directory is supported. This server must reside on an outboard Microsoft Windows server that is connected to the management network.When an external LDAP server is used, the local authentication server is disabled.

2 Lenovo XClarity Administrator REST API Guide

http://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/events_workingwith.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/alerts_workingwith.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/compute_node_image_deployment.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/server_configuring.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/server_configuring.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/update_fw.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/users_manage.html

• External SAML 2.0 identity provider. Currently, only Microsoft Active Directory Federation Services (AD FS) is supported. In addition to entering a user name and password, multi-factor authentication can be set up to enable additional security by requiring a PIN code, reading smart card, and client certificate.

For more information about authentication types, see Managing the authentication server in the Lenovo XClarity Administrator online documentation.

When you create a user account, you assign a predefined or customized role group to the user account to control the level of access for that user. For more information about role groups, see Creating a role group in the Lenovo XClarity Administrator online documentation.

Lenovo XClarity Administrator includes an audit log that provides a historical record of user actions, such as logging on, creating new users, or changing user passwords. For more information about the audit log, see Working with events in the Lenovo XClarity Administrator online documentation.

Device authenticationLenovo XClarity Administrator uses the following methods for authenticating with managed chassis and servers.

• Managed authentication. When managed authentication is enabled, the user accounts that you create in Lenovo XClarity Administrator are used to authenticate managed chassis and servers.

For more information about users, see Managing user accounts in the Lenovo XClarity Administrator online documentation .

• Local authentication. When managed authentication is disabled, the stored credentials that are defined in Lenovo XClarity Administrator are used to authenticate managed servers. The stored credentials must correspond to an active user account on the device or in Active Directory.

For more information about stored credentials, see Managing stored credentials in the Lenovo XClarity Administrator online documentation.

SecurityIf your environment must comply with either NIST SP 800-131A or FIPS 140-2 standards, Lenovo XClarity Administrator can help you achieve a fully compliant environment.

Lenovo XClarity Administrator supports self-signed SSL certificates (which are issued by an internal certificate authority) and external SSL certificates (which are issued by a private or commercial CA).

Firewalls on chassis and servers can be configured to accept incoming requests from only Lenovo XClarity Administrator.

For more information about security, see Implementing a secure environment in the Lenovo XClarity Administrator online documentation.

Service and supportLenovo XClarity Administrator can be set up to collect and send diagnostic files automatically to your preferred service provider when certain serviceable events occur in Lenovo XClarity Administrator and the managed devices. You can choose to send diagnostic files to Lenovo Support using Call Home or to another service provider using SFTP. You can also manually collect diagnostic files, open a problem record, and send diagnostic files to the Lenovo Support Center.

Task automation using scriptsLenovo XClarity Administrator can be integrated into external, higher-level management and automation platforms through open REST application programming interfaces (APIs). Using the REST APIs, Lenovo XClarity Administrator can easily integrate with your existing management infrastructure.

Chapter 1. Lenovo XClarity Administrator Overview 3

http://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/ldapserver_managing.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/rolegroup_create.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/rolegroup_create.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/events_workingwith.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/users_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/storedcredentials_manage.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/security_implement.html

The PowerShell toolkit provides a library of cmdlets to automate provisioning and resource management from a Microsoft PowerShell session. The Python toolkit provides a Python-based library of commands and APIs to automate provisioning and resource management from an OpenStack environment, such as Ansible or Puppet. Both of these toolkits provide an interface to Lenovo XClarity Administrator REST APIs to automate functions such as:

• Logging in to Lenovo XClarity Administrator

• Managing and unmanaging chassis, servers, storage devices, and top-of-rack switches (devices)

• Collecting and viewing inventory data for devices and components

• Deploying an operating-system image to one or more servers

• Configuring servers through the use of Configuration Patterns

• Applying firmware updates to devices

Integration with other managed softwareLenovo XClarity Integrator modules integrate Lenovo XClarity Administrator with third-party management software to provide discovery, monitoring, configuration, and management functions to reduce the cost and complexity of routine system administration for supported devices.

For more information about Lenovo XClarity Integrator, see the following documents: • Lenovo XClarity Integrator for Microsoft System Center• Lenovo XClarity Integrator for VMware vCenter

For additional considerations, see Using management software other than the Lenovo XClarity Administrator in the Lenovo XClarity Administrator online documentation.

DocumentationThe Lenovo XClarity Administrator documentation is updated regularly online in English See the Lenovo XClarity Administrator online documentation for the most current information and procedures.


https://datacentersupport.lenovo.com/us/en/documents/lnvo-managehttps://datacentersupport.lenovo.com/us/en/documents/lnvo-vmwarehttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/plan_mgmtsoftware.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/plan_mgmtsoftware.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/aug_product_page.htmlhttp://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/aug_product_page.html

Chapter 2. Virtual appliance management

The following resources are available for managing the Lenovo XClarity Administrator virtual appliance.

/aiccUse this REST API to retrieve and configure information about the Lenovo XClarity Administrator virtual appliance.

HTTP methods

GET, PUT

GET /aiccUse the GET method to retrieve information about the Lenovo XClarity Administrator, such as NTP server settings, date and time settings, services that are currently running, and the build level.

Authentication

Authentication with user name and password is required.

Request URL

GET https:///aicc

Query parameters

None

Response codes

Code Description

200 OK

Response body

Field Type Description

appliance Object Information about the current instance of the Lenovo XClarity Administrator virtual appliance.

build String The current build level.

date String The current date and time.

name String The current appliance name.

runlevel Integer The current state of the appliance. This can be one of the following values: • 0. The appliance is halted.• 3. The appliance is operating normally.• 6. The appliance is restarting.

status String The current status of the appliance. The value is always “Normal.”

uuid String The UUID of the appliance.

version String The current version number.

© Copyright Lenovo 2015, 2017 5


appliance_states Object A list of all available appliance states.

description String The appliance-state description.

runlevel Integer The appliance-state value.

date Object Information about the current date on the Lenovo XClarity Administrator.

date_time String The date and time.

parts Array Information about the current time.

yyyy Integer Year

mm Integer Month

dd Integer Day

hours Integer Hour

mins Integer Minute

secs Integer Second

timezone String The current time zone.

timezones Object Information about all available time zones.

daylight_saves Integer The amount of time to be added to local standard time to get the current time. This can be one of the following values: • 3600000. If use_daylight is true, adds 3600000 milliseconds (one

hour).• 0. f use_daylight is false, adds 0 milliseconds.

display_name String The time zone name

id String The time zone ID.

offset Integer The Coordinated Universal Time (UTC) offset (for example, -5 or +4).

uses_daylight Boolean Identifies whether daylight saving time is used. This can be one of the following values. • true. Daylight saving time is used.• false. Daylight saving time is not used.

utc_offset_raw Integer The UTC offset (for example, -5 or +4).

utc_offset_w_dst Integer The UTC offset adjusted for daylight saving time, if applicable (for example, -5 or +4).

timezone_id String The time zone ID.

uses_daylight Boolean Identifies whether daylight saving time is used. This can be one of the following values. • true. Daylight saving time is used.• false. Daylight saving time is not used.

utc_offset Integer The UTC offset (for example, -5 or +4).

utc_offset_raw Integer The UTC offset (for example, -5 or +4).

utc_offset_w_dst Integer The UTC offset adjusted for daylight saving time, if applicable (for example, -5 or +4).

network_interfaces Array A list of Lenovo XClarity Administrator network interfaces.



id String The network ID (such as “eth0” or “eth1”).

ip_addresses Array The IPv4 and IPv6 addresses for this interface.

assign_method String The assignment method used for this IP address. This can be one of the following values. • static• dhcp• auto

ip String The IPv4 or IPv6 address.

ip_linklocal Boolean Identifies whether this address is an IPv6 link local address. This can be one of the following values. • true. This address is an IPv6 link local address.• false. This address is not an IPv6 link local address.

prefix_length Integer The prefix length (in bits) for this IP address.

version Integer The IP version of this address. This value is either “4” or “6.”

mac_address String The MAC address.

role Array of strings

The roles that are performed by this interface. This can be one or more of the following values. • data• management• osdeployment

ntp Object Information about the NTP server that is associated with Lenovo XClarity Administrator.

servers Array A list of NTP servers.

authenticated Boolean Indicates whether the Lenovo XClarity Administrator is authenticated with the NTP server. This can be one of the following values. • true. Lenovo XClarity Administrator is authenticated with the NTP

server.• false. Lenovo XClarity Administrator is not authenticated with the

NTP server.

server String The IP address or hostname of the NTP server.

version Integer The version of the NTP server.

v3_key String The key value specified in /etc/ntp/keys.

v3_key_index Integer The key-index value specified in /etc/ntp/keys.

v3_key_type String The key-type value specified in /etc/ntp/keys.

preferredDisplayName String The the property to use to displayed the device names in the user interface. This can be one of the following values. • byDefault. Displays the value that is provided by Lenovo XClarity

Administrator.• userDefinedName• dnsHostname• hostname• ipv4Address• serialNumberIf the selected property is not applicable or is applicable but there is no value available for a device, then byDefault is used.

services Array A list of the Lenovo XClarity Administrator services.

Chapter 2. Virtual appliance management 7


id String The service ID.

initd String The service name.

pid Integer The process ID.

state Integer The current state of the service. This can be one of the following values: • 0. The service is running.• 1. The service is stopped but PID file exists.• 2. The service is stopped but lock file exists.• 3. The service is not running.• 4. The current state of the service is unknown.

service_states Object A list of all available service states.

description String The service-state description.

state Integer The service-state value.

subscriptions Array A list of subscriptions.

id Integer The subscription ID.

monitor_uri String The network-related resource that is to be monitored by Lenovo XClarity Administrator. If monitor_uri is set to “/aicc” or “”, every /aicc URI is monitored.

If monitor_uri is set to “”, IP change notifications are received through DHCP.

uri String The resource to which Lenovo XClarity Administrator writes a POST when Lenovo XClarity Administrator detects a change in monitored resource. The specified URI must be able to accept POST requests, where the body of the POST matches the JSON PUT to monitor_uri.

Response example

When the request is successful, a message body similar to the following is returned:

{ "appliance": {

"build": "110", "date": "2015-09-15_10-25-16", "name": "LXCA - 192.0.2.0", "runlevel": 3, "status": "Normal", "uuid": "bef3e2c3-a689-4734-aa79-2a21f21e8b97", "version": "1.1.0"

}, "appliance_states": [{

"description": "Halt the appliance", "runlevel": 0

}, ..., {

"description": "Reboot the appliance", "runlevel": 6

}], "date": {

"date_time": "September 18, 2015 8:45:54 AM EST",


"parts": { "yyyy": 2015, "mm": 9, "dd": 18, "hours": 8, "mins": 45 "secs": 54,

}, "timezone": "Eastern Standard Time", "timezones": [{

"daylight_saves": 0, "display_name": "GMT-12:00", "id": "Etc/GMT+12", "offset": -43200000, "uses_daylight": false, "utc_offset_raw": -43200000, "utc_offset_w_dst": -43200000

}, ..., {

"daylight_saves": 0, "display_name": "Eastern Standard Time", "id": "America/Grand_Turk", "offset": -14400000, "uses_daylight": false, "utc_offset_raw": -18000000, "utc_offset_w_dst": -14400000

}], "timezone_id": "America/Cayman", "uses_daylight": true, "utc_offset": -18000000, "utc_offset_raw": -18000000, "utc_offset_w_dst": -18000000

} "network_interfaces": [{

"id": "eth0", "ip_addresses": [{

"assign_method": "static", "ip": "fe80:0:0:0:200:ff:fe00:10%2", "ip_linklocal": "true", "prefix_length": 64, "version": 6

}, {

"assign_method": "static", "ip": "192.0.2.0", "ip_linklocal": "false", "prefix_length": 22, "version": 4

}], "mac_address": "00:00:00:00:00:10", "role": ["management", "osdeployment"]

}], "ntp": {

"servers": [{ "authenticated": false, "server": "us.pool.ntp.org", "version": 1, "v3_key": "", "v3_key_index": 0, "v3_key_type": ""


}] }, "preferredDisplayName": "hostname", "services": [{

"id": "core", "initd": "xhmc-core", "pid": 52706, "state": 0

}, ..., {

"id": "watchdog", "initd": "sympl-watchdog", "pid": 52517, "state": 0

}], "service_states": [{

"description": "Service is running", "state": 0

}, ..., {

"description": "Special purpose state used to trigger restart through REST", "state": 191

}], "subscriptions": [{

"id": 1, "monitor_uri": "/aicc", "uri": "/ntpNotification"

}, ..., {

"id": 3, "monitor_uri": "", "uri": "/osdeployment/rest/internal/event/aicc"

}], }

PUT /aiccUse the PUT method to configure Lenovo XClarity Administrator settings (such as NTP server settings, date and time settings, and services that are currently running), change the virtual appliance name, and restart or shutdown the virtual appliance.

Note: Restarting or shutting down the virtual appliance causes any outstanding jobs to be interrupted and stopped. Before calling PUT /aicc to shutdown or restart the virtual appliance, use “GET /jobs” on page 666to check for any outstanding jobs.

Authentication


Request URL

PUT https:///aicc

Query parameters

None


Request body

Field

Re-quired / Optional Type Description

appliance Optional Object Information about the current instance of the Lenovo XClarity Administrator virtual appliance

name Optional String The name of the virtual appliance.

runlevel Optional Integer The appliance run level. This can be one of the following values: • 0. Shut down• 6. Restart

date Optional Object Information about the current date and time on Lenovo XClarity Administrator.

parts Optional Array The current date and time.

yyyy Optional Integer Year.

mm Optional Integer Month.

dd Optional Integer Day.

hours Optional Integer Hour.

mins Optional Integer Minute.

secs Optional Integer Second.

timezone_id Optional String The time zone ID.

ntp Optional Object Information about the NTP server that is associated with Lenovo XClarity Administrator.

servers Optional Array A list of NTP servers.

server Required String The IP address or hostname of the NTP server.

sync Required Boolean Indicates whether Lenovo XClarity Administrator synchronizes with the NTP server specified with the server parameter.

version Optional Integer The version of the NTP server. You can specify one of the following values:

• 1. No key authentication is required.

• 3. NTPv3 is used, and key authentication is required. You must specify the authentication key and index for the NTP server for M-MD5 or SHA1 or both using the v3_key, v3_key_type, and v3_key_index parameters.

v3_key Optional String The authentication key. • For the M-MD5 key, specify an ASCII string.• For the SHA1 key, specify a 40-character ASCII string,

including only 0–9 and a-f.Note: The key index and authentication key must match the key ID and password values set on the NTP server. See the documentation for your NTP server for information about setting the key ID and key index.


Field


v3_key_type Optional String The authentication key-type. You can specify one of the following values: • M. M-MD5 authentication.• SHA1. SHA1 authentication

v3_key_index Optional String The authentication key index. Note: The key index and authentication key must match the key ID and password values set on the NTP server. See the documentation for your NTP server for information about setting the key ID and password.

preferredDisplayName Optional String The the property to use to displayed the device names in the user interface. This can be one of the following values. • byDefault. Displays the value that is provided by

Lenovo XClarity Administrator.• userDefinedName• dnsHostname• hostname• ipv4Address• serialNumberIf the selected property is not applicable or is applicable but there is no value available for a device, then byDefault is used.

services Optional Array A list of the Lenovo XClarity Administrator services.

id Optional String The service ID. To obtain the service IDs, use “GET /aicc” on page 5.

state Optional Integer The current state of the service. This can be one of the following values: • 191. Restart the service.

Request example

The following example sets an NTPv1 server.

{ "ntp": {

"servers": [{ "server": "1.1.1.2", "version": 1

}] }

}

The following example sets an NTPv3 server using both M-MD5 and SHA1 authentication:

{ "ntp": {

"servers": [{ "server": "time-a.nist.gov", "version": 3 "v3_key": "123456789012345678901234567890abcdefabcd", "v3_key_index": 3, "v3_key_type": "M",

}, {


"server": "us.pool.ntp.org", "version": 3, "v3_key": "123456789012345678901234567890abcdefabcd" "v3_key_index": 1, "v3_key_type": "SHA1",

}] }

}

The following example synchronizes Lenovo XClarity Administrator with the NTP server.

{ "ntp": {

"servers": [{ "server": "time-a.nist.gov", "sync": "true"

}] }

}

The following example sets the time zone. {

"date": { "timezone_id": "America/ New_York"

} }

The following example sets the date and time. {

"date": { "parts": {

"yyyy": 2014, "dd": 7, "mm": 5, "hours": 2, "mins": 10, "secs": 24

} }

}

The following example restarts network services. {

"services": [{ "id": "network", "state": 191

}] }

The following example shuts down the virtual appliance. {

"appliance": { "runlevel": 0

} }

The following example restarts the virtual appliance. {

"appliance": { "runlevel": 6


} }

The following example changes the virtual appliance name. {

"appliance": { "name" : "myAppliance"

} }

The following example displays the device names using the IPv6 address of the device. {

"preferredDisplayName": "ipv6Address" }

}

Response codes

Code Description

200 OK

400 Bad request

Response body

None

/aicc/network/ipdisableUse this REST API to retrieve or modify the IP address enablement state.

HTTP methods

GET, PUT

GET /aicc/network/ipdisableUse the GET method to retrieve the enablement state of IPv4 and IPv6 addresses.

Authentication


Request URL

GET https:///aicc/network/ipdisable

Query parameters

None

Request body

None


Response codes

Code Description

200 OK

404 Not Found

Response body


ip_status Array of objects

Information about the enablement state for IPv4 and IPv6 addresses.

ip_version Integer The type of IP address. This can be one of the following values: • 4. IPv4 addresses• 6. IPv6 addresses

ip_disable Integer Indicates whether the IP addresses are enabled or disabled. This can be one of the following values: • 0. Enable the specified addresses.• 1. Disable the specified addresses.

Response example

{ "ip_status": [{

"ip_disable": 0, "ip_version": 4

}, {

"ip_disable": 0, "ip_version": 6

}] }

PUT /aicc/network/ipdisableUse the PUT method to enable or disable IPv4 or IPv6 addresses. You must enable or disable the IP addresses one at a time.

Authentication


Request URL

PUT https:///aicc/network/ipdisable

Query parameters

None


Request body

Field


ip_version Required Integer The type of IP address. This can be one of the following values: • 4. IPv4 addresses• 6. IPv6 addresses

ip_disable Required Integer Indicates whether the IP addresses are enabled or disabled. This can be one of the following values: • 0. Enable the specified addresses.• 1. Disable the specified addresses.

Request example

The following example enables IPv4 addresses: {

"ip_version" : 4, "ip_disable" : 0

}

The following example disables IPv4 addresses: {

"ip_version" : 4, "ip_disable" : 1

}

Response codes

Code Description

200 OK

400 Bad request

Response body

None

/aicc/network/hostUse this REST API to retrieve or configure information about the Lenovo XClarity Administrator host.

HTTP methods

GET, PUT

GET /aicc/network/hostUse the GET method to retrieve the Lenovo XClarity Administrator host settings.

Authentication


Request URL

GET https:///aicc/network/host


Query parameters

Non

Lenovo XClarity Administrator REST API Guide · Before using this information and the product it...

Documents

Transcript of Lenovo XClarity Administrator REST API Guide · Before using this information and the product it...