features_ipmi_accesses

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

Overview

Name	features_ipmi_accesses
Type	Resource
Id	ovh.dedicated_server.features_ipmi_accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
expiration	string (date-time)	Session expiration date
value	string	value

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, type		Get the IPMI session access. Returns the access value and the session expiration date for the given access type. Request the access with POST on the same route first: before that, and after expiration, the call returns an error.
create	insert	service_name, ttl, type		Request IPMI access. Requests an IPMI session for the given access type and returns a task. Once the task is done, read the access value and its expiration date with GET on the same route. sshKey, for serial over LAN SSH access, must be a raw public SSH key.

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	IPMI console access

SELECT examples

get

Get the IPMI session access. Returns the access value and the session expiration date for the given access type. Request the access with POST on the same route first: before that, and after expiration, the call returns an error.

SELECT
expiration,
value
FROM ovh.dedicated_server.features_ipmi_accesses
WHERE service_name = '{{ service_name }}' -- required
AND type = '{{ type }}' -- required
;

INSERT examples

create

Request IPMI access. Requests an IPMI session for the given access type and returns a task. Once the task is done, read the access value and its expiration date with GET on the same route. sshKey, for serial over LAN SSH access, must be a raw public SSH key.

INSERT INTO ovh.dedicated_server.features_ipmi_accesses (
ip_to_allow,
ssh_key,
ttl,
type,
service_name
)
SELECT 
'{{ ip_to_allow }}',
'{{ ssh_key }}',
{{ 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_accesses
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the features_ipmi_accesses resource.
  - name: ip_to_allow
    value: "{{ ip_to_allow }}"
    description: |
      IP to allow connection from for this IPMI session
  - name: ssh_key
    value: "{{ ssh_key }}"
    description: |
      Public SSH key for Serial Over Lan SSH access | ⚠️ Starting 2024-08-27, SSH key name will no longer be accepted and only raw public SSH key will remain accepted
  - name: ttl
    value: {{ ttl }}
    description: |
      Session access time to live in minutes
    valid_values: ['1', '3', '5', '10', '15']
  - name: type
    value: "{{ type }}"
    description: |
      Distinct way to acces a KVM IPMI session
    valid_values: ['kvmipHtml5URL', 'kvmipJnlp', 'serialOverLanSshKey', 'serialOverLanURL']