features_ipmis
Creates, updates, deletes, gets or lists a features_ipmis resource.
Overview​
| Name | features_ipmis |
| Type | Resource |
| Id | ovh.dedicated_server.features_ipmis |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
activated | boolean | true, if IPMI is available on this server |
supported_features | object | A structure describing the IPMI supported features (wire: supportedFeatures) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Get the IPMI interface. Returns whether IPMI is available on the server and which access methods it supports. KVM is reached through an HTML or Java web interface, and the virtual serial port through an HTML interface or an SSH client. | |
reset_interface | exec | serviceName | Reset the IPMI interface. Resets the IPMI interface of the server and returns a task. The task carries the status and the completion date of the reset. | |
reset_sessions | exec | serviceName | Reset IPMI sessions. Resets the IPMI sessions of the server and returns a task. Access values obtained before the reset stop working and must be requested again. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceName | string | The internal name of your dedicated server |
service_name | string | The internal name of your dedicated server (wire: serviceName) |
SELECT examples​
- get
Get the IPMI interface. Returns whether IPMI is available on the server and which access methods it supports. KVM is reached through an HTML or Java web interface, and the virtual serial port through an HTML interface or an SSH client.
SELECT
activated,
supported_features
FROM ovh.dedicated_server.features_ipmis
WHERE service_name = '{{ service_name }}' -- required
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- reset_interface
- reset_sessions
Reset the IPMI interface. Resets the IPMI interface of the server and returns a task. The task carries the status and the completion date of the reset.
EXEC ovh.dedicated_server.features_ipmis.reset_interface
@serviceName='{{ serviceName }}' --required
;
Reset IPMI sessions. Resets the IPMI sessions of the server and returns a task. Access values obtained before the reset stop working and must be requested again.
EXEC ovh.dedicated_server.features_ipmis.reset_sessions
@serviceName='{{ serviceName }}' --required
;