In this blog we are exploring the VxRail API for daily administrative tasks. To get an overview of available APIs, developer.dell.com is a good starting point. You can explore API for all Dell products on the website, including VxRail.
The VxRail API uses the VMware vCenter single sign on (SSO) for authentication. Use your vCenter username and password to log into the VxRail API. The API passes the credentials to the vCenter for authentication.
The below GET queries provide a sample of how you could monitor your VxRail cluster using API. They provide an overview of health status, version, configuration details and hardware configuration.
Retrieve information about the VxRail Manager system, such as software versions, health status, installed software components.
.\curl.exe -X GET 'https://vxrailmanager/rest/vxm/v2/system' -u $user
{
"description":"A hyperconverged infrastructure appliance that combines VMware compute, networking and storage into one single system for ease of deployment and management.",
"version":"7.0.320-27377804",
"health":"Healthy",
"installed_time":1646936253907,
"network_connected":true,
"vc_connected":true,
"installed_components":[
{
"component":"MysticManager",
"name":"VxRail Manager",
"description":"The management component that orchestrates the deployment and management of VxRail system.",
"supported":true,
"current_version":"7.0.320-27377804",
"baseline_drifted":false,
"multiple_version":false
},
{
"component":"Vcenter",
"name":"VMware vCenter Server Appliance",
"description":"Centralized visibility, proactive management and extensibility for VMware vSphere from a single console VMware vCenter Server provides a centralized platform for managing your VMware vSphere environments, so you can automate and deliver a virtual infrastructure with confidence.",
"supported":true,
"current_version":"7.0.3-19234570",
"baseline_drifted":false,
"multiple_version":false
},
{
"component":"VxRailVib",
"name":"VxRail Manager VIB",
"description":"VxRail Manager agent installed on ESXi.",
"supported":true,
"current_version":"7.0.320-19220338",
"baseline_drifted":false,
"multiple_version":false,
"installed_time":1646934491136000
},
{
"component":"Esx",
"name":"VMware ESXi",
"description":"VMware ESXi is a thin hypervisor integrated into server hardware. The compact, hardware embedded architecture of VMware ESXi raises the bar for security and reliability and lays the foundation for a dynamic, automated datacenter.",
"supported":true,
"current_version":"7.0.3-19193900",
"baseline_drifted":false,
"multiple_version":false,
"installed_time":1646934360064000
}
],
"number_of_host":4,
"deployment_type":[
"STANDARD",
"VCF_VxRail"
],
"is_external_vc":true,
"logical_view_status":false
}
Get VxRail cluster information and basic information about the appliances in the cluster.
.\curl.exe -X GET 'https://vxrailmanager/rest/vxm/v1/cluster' -u $user
{
"cluster_id": "5298670a-6888-1457-e5cc-c6219a761f05",
"product_type": "VSPEXPLUS",
"device_type": "VSPEXBLUE",
"vc_connected": true,
"health": "Healthy",
"operational_status": "ok",
"chassises": [
{
"id": "DE300214158763",
"psnt": "DE300214158763",
"model": "VxRail E660F",
"render_category": "DELL_R650",
"generation": 3,
"health": "Healthy",
"missing": false
},
{
"id": "DE300214158747",
"psnt": "DE300214158747",
"model": "VxRail E660F",
"render_category": "DELL_R650",
"generation": 3,
"health": "Healthy",
"missing": false
},
{
"id": "DE300214158746",
"psnt": "DE300214158746",
"model": "VxRail E660F",
"render_category": "DELL_R650",
"generation": 3,
"health": "Healthy",
"missing": false
},
{
"id": "DE300214158748",
"psnt": "DE300214158748",
"model": "VxRail E660F",
"render_category": "DELL_R650",
"generation": 3,
"health": "Healthy",
"missing": false
}
],
"suppressed": false,
"last_time": "2022-08-03T21:07:36.357000Z"
Get a list of VxRail hosts and their associated subcomponent information. (Only included output for one host for readability purposes)
.\curl.exe -X GET 'https://vxrailmanager/rest/vxm/v6/hosts' -u $user
[
{
"id": "1H6BQJ3",
"sn": "1H6BQJ3",
"type": "CLUSTER",
"slot": 1,
"hostname": "node-02.29cc.lab",
"name": "node-02.29cc.lab",
"manufacturer": "Dell Inc.",
"psnt": "DE300214158746",
"led_status": "Blue:On",
"health": "Healthy",
"missing": false,
"tpm_present": true,
"operational_status": "normal",
"power_status": "on",
"boot_devices": [
{
"id": "21273053F906",
"sn": "21273053F906",
"device_model": "MTFDDAV480TDS",
"sata_type": "SSD",
"power_on_hours": null,
"power_cycle_count": null,
"max_erase_count": null,
"avr_erase_count": null,
"slot": 0,
"capacity": "447.13GB",
"health": "100%",
"firmware_version": "D3DJ004",
"bootdevice_type": "M.2 Riser",
"status": "NORMAL",
"block_size": "512",
"part_number": "MY07RKD7MCK0017315N6A00",
"manufacturer": "MICRON",
"controller_firmware": "2.5.13.4008",
"controller_model": "BOSS-S2",
"controller_status": "NORMAL"
},
{
"id": "212730540892",
"sn": "212730540892",
"device_model": "MTFDDAV480TDS",
"sata_type": "SSD",
"power_on_hours": null,
"power_cycle_count": null,
"max_erase_count": null,
"avr_erase_count": null,
"slot": 1,
"capacity": "447.13GB",
"health": "100%",
"firmware_version": "D3DJ004",
"bootdevice_type": "M.2 Riser",
"status": "NORMAL",
"block_size": "512",
"part_number": "MY07RKD7MCK0017315NZA00",
"manufacturer": "MICRON",
"controller_firmware": "2.5.13.4008",
"controller_model": "BOSS-S2",
"controller_status": "NORMAL"
}
],
"nics": [
{
"id": "B0:7B:25:E9:97:16",
"type": "EMBEDDED",
"mac": "B0:7B:25:E9:97:16",
"link_status": "Down",
"link_speed": "0 Gbps",
"slot": 1,
"port": -1,
"firmware_family_version": "21.81.3",
"drivers": [
{
"driver_name": "ntg3",
"driver_version": "4.1.7.0"
}
]
},
{
"id": "B0:7B:25:E9:97:17",
"type": "EMBEDDED",
"mac": "B0:7B:25:E9:97:17",
"link_status": "Down",
"link_speed": "0 Gbps",
"slot": 2,
"port": -1,
"firmware_family_version": "21.81.3",
"drivers": [
{
"driver_name": "ntg3",
"driver_version": "4.1.7.0"
}
]
},
{
"id": "E4:3D:1A:D9:E3:D0",
"type": "INTEGRATED",
"mac": "E4:3D:1A:D9:E3:D0",
"link_status": "Up",
"link_speed": "25 Gbps",
"slot": 3,
"port": -1,
"firmware_family_version": "21.85.21.91",
"drivers": [
{
"driver_name": "bnxtnet",
"driver_version": "218.0.62.0"
}
]
},
{
"id": "E4:3D:1A:D9:E3:D1",
"type": "INTEGRATED",
"mac": "E4:3D:1A:D9:E3:D1",
"link_status": "Up",
"link_speed": "25 Gbps",
"slot": 4,
"port": -1,
"firmware_family_version": "21.85.21.91",
"drivers": [
{
"driver_name": "bnxtnet",
"driver_version": "218.0.62.0"
}
]
},
{
"id": "E4:3D:1A:8F:11:80",
"type": "pcie",
"mac": "E4:3D:1A:8F:11:80",
"link_status": "Up",
"link_speed": "25 Gbps",
"slot": 1,
"port": 1,
"firmware_family_version": "21.85.21.91",
"drivers": [
{
"driver_name": "bnxtnet",
"driver_version": "218.0.62.0"
}
]
},
{
"id": "E4:3D:1A:8F:11:81",
"type": "pcie",
"mac": "E4:3D:1A:8F:11:81",
"link_status": "Up",
"link_speed": "25 Gbps",
"slot": 1,
"port": 2,
"firmware_family_version": "21.85.21.91",
"drivers": [
{
"driver_name": "bnxtnet",
"driver_version": "218.0.62.0"
}
]
},
{
"id": "",
"type": "hba",
"mac": "",
"link_status": "Down",
"link_speed": "0 Gbps",
"slot": 3,
"port": 1,
"firmware_family_version": "03.05.20",
"drivers": [
{
"driver_name": "lpfc",
"driver_version": "14.0.169.25"
}
]
},
{
"id": "",
"type": "hba",
"mac": "",
"link_status": "Down",
"link_speed": "0 Gbps",
"slot": 3,
"port": 2,
"firmware_family_version": "03.05.20",
"drivers": [
{
"driver_name": "lpfc",
"driver_version": "14.0.169.25"
}
]
}
],
"disks": [
{
"id": "61U0A0FHT8C8",
"sn": "61U0A0FHT8C8",
"guid": "58ce38ee217f0c8d",
"manufacturer": "KIOXIA",
"model": "KPM6XMUG800G",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 8,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "745.21GB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "BA08",
"disk_claim_type": "vSAN"
},
{
"id": "61U0A0FCT8C8",
"sn": "61U0A0FCT8C8",
"guid": "58ce38ee217f0c69",
"manufacturer": "KIOXIA",
"model": "KPM6XMUG800G",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 9,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "745.21GB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "BA08",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R807276",
"sn": "S5YNNA0R807276",
"guid": "5002538b2181cc00",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 6,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R807273",
"sn": "S5YNNA0R807273",
"guid": "5002538b2181cbd0",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 5,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R807275",
"sn": "S5YNNA0R807275",
"guid": "5002538b2181cbf0",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 4,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R804648",
"sn": "S5YNNA0R804648",
"guid": "5002538b21811690",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 2,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R807278",
"sn": "S5YNNA0R807278",
"guid": "5002538b2181cc20",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 1,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
},
{
"id": "S5YNNA0R804539",
"sn": "S5YNNA0R804539",
"guid": "5002538b21810fc0",
"manufacturer": "SAMSUNG",
"model": "MZILT3T8HBLS0D3",
"disk_type": "SSD",
"protocol": "SAS",
"max_capable_speed": "12 Gb/s",
"enclosure": 0,
"bay": 1,
"slot": 0,
"disk_state": "OK",
"led_status": "Green:On",
"missing": false,
"capacity": "3.49TB",
"write_endurance": "0",
"write_endurance_status": null,
"remaining_write_endurance_rate": "100%",
"firmware_revision": "DSA3",
"disk_claim_type": "vSAN"
}
],
"firmwareInfo": {
"bios_revision": "1.3.8",
"bmc_revision": "5.00.10.20",
"hba_version": "03.05.20",
"expander_bpf_version": null,
"nonexpander_bpf_version": "3.56",
"boss_version": "2.5.13.4008",
"cpld_version": "1.0.5",
"idsdm_version": null,
"dcpm_version": null,
"perc_version": null
},
"part_number": null,
"geo_location": {
"rack_name": "29cc",
"order_number": 1
},
"drive_configuration": {
"type": "1002"
}
},
]
Retrieves information on configured hosts in the VxRail cluster.
.\curl.exe -X GET 'https://vxrailmanager/rest/vxm/v1/system/cluster-hosts' -u $user
[
{
"id": "DE300214158763-01-01",
"serial_number": "JG6BQJ3",
"psnt": "DE300214158763",
"host_name": "node-04.29cc.lab",
"appliance_id": "DE300214158763",
"slot": 1,
"manufacturer": "Dell Inc.",
"model": "VxRail E660F",
"operational_status": "normal",
"health": "Healthy",
"power_status": "on",
"led_status": "Blue:On",
"tpm_present": true,
"is_primary_node": false,
"missing": false,
"cluster_affinity": true,
"ip_set": {
"management_ip": "192.168.0.14",
"vsan_ip": "192.168.2.14",
"vmotion_ip": "192.168.1.14"
},
"discovered_date": null,
"bios_uuid": "4c4c4544-0047-3610-8042-cac04f514a33",
"segment_label": null
},
{
"id": "DE300214158747-01-01",
"serial_number": "2H6BQJ3",
"psnt": "DE300214158747",
"host_name": "node-03.29cc.lab",
"appliance_id": "DE300214158747",
"slot": 1,
"manufacturer": "Dell Inc.",
"model": "VxRail E660F",
"operational_status": "normal",
"health": "Healthy",
"power_status": "on",
"led_status": "Blue:On",
"tpm_present": true,
"is_primary_node": false,
"missing": false,
"cluster_affinity": true,
"ip_set": {
"management_ip": "192.168.0.13",
"vsan_ip": "192.168.2.13",
"vmotion_ip": "192.168.1.13"
},
"discovered_date": null,
"bios_uuid": "4c4c4544-0048-3610-8042-b2c04f514a33",
"segment_label": null
},
{
"id": "DE300214158746-01-01",
"serial_number": "1H6BQJ3",
"psnt": "DE300214158746",
"host_name": "node-02.29cc.lab",
"appliance_id": "DE300214158746",
"slot": 1,
"manufacturer": "Dell Inc.",
"model": "VxRail E660F",
"operational_status": "normal",
"health": "Healthy",
"power_status": "on",
"led_status": "Blue:On",
"tpm_present": true,
"is_primary_node": true,
"missing": false,
"cluster_affinity": true,
"ip_set": {
"management_ip": "192.168.0.12",
"vsan_ip": "192.168.2.12",
"vmotion_ip": "192.168.1.12"
},
"discovered_date": null,
"bios_uuid": "4c4c4544-0048-3610-8042-b1c04f514a33",
"segment_label": null
},
{
"id": "DE300214158748-01-01",
"serial_number": "9G6BQJ3",
"psnt": "DE300214158748",
"host_name": "node-01.29cc.lab",
"appliance_id": "DE300214158748",
"slot": 1,
"manufacturer": "Dell Inc.",
"model": "VxRail E660F",
"operational_status": "normal",
"health": "Healthy",
"power_status": "on",
"led_status": "Blue:On",
"tpm_present": true,
"is_primary_node": false,
"missing": false,
"cluster_affinity": true,
"ip_set": {
"management_ip": "192.168.0.11",
"vsan_ip": "192.168.2.11",
"vmotion_ip": "192.168.1.11"
},
"discovered_date": null,
"bios_uuid": "4c4c4544-0047-3610-8042-b9c04f514a33",
"segment_label": null
}
]
Retrieves information about the call home servers.
.\curl.exe -X GET 'https://vxrailmanager/rest/vxm/v2/callhome/info' -u $user
{
"status":"not_configured",
"integrated":false,
"address_list":[
]
}