IBM Fusion appliance management API
The IBM Fusion HCI API references.
- Compute APIs
-
- List of compute monitoring CRs
-
GET /api/v1/compute-monitorings
- Get a specific
ComputeMonitoring
CR -
GET /api/v1/compute-monitorings/<node-name>
- List of
ComputeConfiguration
CRs -
GET /api/v1/compute-configurations
- Enable maintenance mode for compute node
-
POST /api/v1/compute/update/maitenancemode/<node-name>
Payload:{"maintenanceMode":"true"}
- Power operation for compute node
-
POST /api/v1/compute/update/poweroperation/<node-name>
Payload:{"maintenanceMode":"true"}
Note: The node must be in maintenance mode before calling this API. To enable the maintenance mode, call the Enable maintenance mode for compute node API.
- Add new compute node
-
POST /api/v1/computeconfig
Payload:[{"linkLocal":"<linklocaladdress","ru":"<RUnumber>","ibmSerialNumber":"<ibmserialnumber>","rackSerialNumber":"<rackname>"}]
To check the added node, check the
successNodes
field in the response. An empty list means that the compute node failed to add to the cluster.
- Add node to storage cluster (scale out)
-
PUT /api/v1/compute/scaleout
Payload:{"scaleOutNodes":"compute-0,compute-2,compute-3"}
To confirm success of scale out, call the
GET compute node
API.
- Check compute node storage
-
GET /api/v1/addstorage/info
- Add storage disks (scale up)
-
PUT /api/v1/compute/scaleup
This API is applicable only if additional storage disks are available.
For successful scale, check storage information. To check the information, call the Check compute node storage API before and after this PUT API call.GET /api/v1/addstorage/info before this.
- Networking APIs
-
Note: If you using Alternative network configuration, then the links related APIs are not applicable.
- List all network switches
-
GET /api/v1/network/switches
- List all network VLANs
-
GET /api/v1/network/vlans
- List all network links
-
GET /api/v1/network/links
- List all network switch commands
-
GET /api/v1/network/listcommands
- Run network switch command
-
GET /api/v1/networkcommands/<switch-name>/<command>
- Create new VLAN
-
POST /api/v1/network/vlans/rack-vlans/add/
Payload:{"vlanId":<vlan-id>,"vlanName":<vlan-name> ,"vlanType":<vlan-type>,"multipleLinks": <yes/no>}
- Update VLAN
-
POST /api/v1/network/vlans/rack-vlans/update/<vlan-id>
Payload:{"vlanId":<vlan-id>,"vlanName":<vlan-name> ,"vlanType":<vlan-type>,"multipleLinks": <yes/no>}
- Create new link
-
POST /api/v1/network/links/rack-links/add/
Payload:{"name":<link-name> ,"ports":<port>,"vlanType": <type>,"transceiver":<transceiver-value> ,aggregation":true,"nativeVlan":<native-vlan-name>,"vlanNames":<vlan-names> }
- Edit the link
-
POST /api/v1/network/links/rack-links/update/<uuid>
Payload:{"name":<link-name> ,"ports":<port>,"vlanType": <type>,"transceiver":<transceiver-value> ,aggregation":true,"nativeVlan":<native-vlan-name>,"vlanNames":<vlan-names> }
- Upgrade
-
- IBM Fusion upgrade status
-
GET /api/v1/upgrade