ssls

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

Overview

Name	ssls
Type	Resource
Id	ovh.ip_loadbalancing.ssls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of your SSL certificate
display_name	string	Human readable name for your ssl certificate, this field is for you (wire: displayName)
expire_date	string (date-time)	Expire date of your SSL certificate (wire: expireDate)
fingerprint	string	Fingerprint of your SSL certificate
san	array	Subject Alternative Name of your SSL certificate
serial	string	Serial of your SSL certificate (Deprecated, use fingerprint instead !)
subject	string	Subject of your SSL certificate
type	string	Type of your SSL certificate. 'built' for SSL certificates managed by the IP Load Balancing. 'custom' for user manager certificates. (built, built_not_routed, custom)

list

Ssl

Name	Datatype	Description
id	integer	Id of your SSL certificate
display_name	string	Human readable name for your ssl certificate, this field is for you (wire: displayName)
expire_date	string (date-time)	Expire date of your SSL certificate (wire: expireDate)
fingerprint	string	Fingerprint of your SSL certificate
san	array	Subject Alternative Name of your SSL certificate
serial	string	Serial of your SSL certificate (Deprecated, use fingerprint instead !)
subject	string	Subject of your SSL certificate
type	string	Type of your SSL certificate. 'built' for SSL certificates managed by the IP Load Balancing. 'custom' for user manager certificates. (built, built_not_routed, custom)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get an SSL certificate
list	select	service_name	expire_date, fingerprint, serial, type, x_pagination_mode	List SSL certificates
create	insert	service_name, certificate, key		Create a custom SSL certificate
update	update	id, service_name		Update an SSL certificate
delete	delete	id, service_name		Delete an SSL certificate

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"}})
id	integer	Id of your SSL certificate
service_name	string	The internal name of your IP load balancing (wire: serviceName)
expire_date	string (date-time)	Filter the value of expireDate property (<) (wire: expireDate)
fingerprint	string	Filter the value of fingerprint property (like)
serial	string	Filter the value of serial property (like)
type	string	Filter the value of type property (=)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get an SSL certificate

SELECT
id,
display_name,
expire_date,
fingerprint,
san,
serial,
subject,
type
FROM ovh.ip_loadbalancing.ssls
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List SSL certificates

SELECT
id,
display_name,
expire_date,
fingerprint,
san,
serial,
subject,
type
FROM ovh.ip_loadbalancing.ssls
WHERE service_name = '{{ service_name }}' -- required
AND expire_date = '{{ expire_date }}'
AND fingerprint = '{{ fingerprint }}'
AND serial = '{{ serial }}'
AND type = '{{ type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a custom SSL certificate

INSERT INTO ovh.ip_loadbalancing.ssls (
certificate,
chain,
display_name,
key,
service_name
)
SELECT 
'{{ certificate }}' /* required */,
'{{ chain }}',
'{{ display_name }}',
'{{ key }}' /* required */,
'{{ service_name }}'
RETURNING
id,
display_name,
expire_date,
fingerprint,
san,
serial,
subject,
type
;

Manifest

# Description fields are for documentation purposes
- name: ssls
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ssls resource.
  - name: certificate
    value: "{{ certificate }}"
    description: |
      Certificate
  - name: chain
    value: "{{ chain }}"
    description: |
      Certificate chain
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human readable name for your ssl certificate, this field is for you
  - name: key
    value: "{{ key }}"
    description: |
      Certificate key

UPDATE examples

update

Update an SSL certificate

UPDATE ovh.ip_loadbalancing.ssls
SET 
display_name = '{{ display_name }}'
WHERE 
id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete an SSL certificate

DELETE FROM ovh.ip_loadbalancing.ssls
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;