features_ipmi_tests

Creates, updates, deletes, gets or lists a features_ipmi_tests resource.

Overview

Name	features_ipmi_tests
Type	Resource
Id	ovh.dedicated_server.features_ipmi_tests

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
date	string (date-time)	Test running date
status	string	Test result

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, type		Get an IPMI test result. Returns the result and the run date of the IPMI test of the given type: http, password or ping. Launch the test with POST on the same route first; the result is kept only for the ttl given at launch.
create	insert	service_name, ttl, type		Test the IPMI interface. Launches an http, password or ping test on the IPMI interface and returns a task. ttl sets how long the result is kept: 1, 3, 5, 10 or 15 minutes. The result is read with GET on the same route.

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"}})
service_name	string	The internal name of your dedicated server (wire: serviceName)
type	string	Test type result on KVM IPMI interface

SELECT examples

get

Get an IPMI test result. Returns the result and the run date of the IPMI test of the given type: http, password or ping. Launch the test with POST on the same route first; the result is kept only for the ttl given at launch.

SELECT
date,
status
FROM ovh.dedicated_server.features_ipmi_tests
WHERE service_name = '{{ service_name }}' -- required
AND type = '{{ type }}' -- required
;

INSERT examples

create

Test the IPMI interface. Launches an http, password or ping test on the IPMI interface and returns a task. ttl sets how long the result is kept: 1, 3, 5, 10 or 15 minutes. The result is read with GET on the same route.

INSERT INTO ovh.dedicated_server.features_ipmi_tests (
ttl,
type,
service_name
)
SELECT 
{{ ttl }} /* required */,
'{{ type }}' /* required */,
'{{ service_name }}'
RETURNING
planned_intervention_id,
task_id,
change_uuid,
comment,
done_date,
function,
last_update,
need_schedule,
note,
start_date,
status,
tags,
ticket_reference
;

Manifest

# Description fields are for documentation purposes
- name: features_ipmi_tests
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the features_ipmi_tests resource.
  - name: ttl
    value: {{ ttl }}
    description: |
      Result time to live in minutes
    valid_values: ['1', '3', '5', '10', '15']
  - name: type
    value: "{{ type }}"
    description: |
      Different test can be made on IPMI interface
    valid_values: ['http', 'password', 'ping']