servers

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

Overview

Name	servers
Type	Resource
Id	ovh.ssl_gateway.servers

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Id of your server
address	string (ipv4)	IP address of the server attached to your SSL Gateway (example: 192.0.2.0)
port	integer	Port of your server attached to your SSL Gateway
state	string	Server state (creating, deleted, deleting, internal, ok, updating)

list

Server attached to an SSL Gateway

Name	Datatype	Description
id	integer	Id of your server
address	string (ipv4)	IP address of the server attached to your SSL Gateway (example: 192.0.2.0)
port	integer	Port of your server attached to your SSL Gateway
state	string	Server state (creating, deleted, deleting, internal, ok, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get a server (Beta version)
list	select	service_name	x_pagination_mode	List servers (Beta version)
create	insert	service_name, address, port		Add a server (Beta version)
update	update	id, service_name		Update a server (Beta version)
delete	delete	id, service_name		Remove a server (Beta version)

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 server
service_name	string	The internal name of your SSL Gateway (wire: serviceName)
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 a server (Beta version)

SELECT
id,
address,
port,
state
FROM ovh.ssl_gateway.servers
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List servers (Beta version)

SELECT
id,
address,
port,
state
FROM ovh.ssl_gateway.servers
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add a server (Beta version)

INSERT INTO ovh.ssl_gateway.servers (
address,
port,
service_name
)
SELECT 
'{{ address }}' /* required */,
{{ port }} /* required */,
'{{ service_name }}'
RETURNING
id,
address,
port,
state
;

Manifest

# Description fields are for documentation purposes
- name: servers
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the servers resource.
  - name: address
    value: "{{ address }}"
    description: |
      IPv4 address of your server
  - name: port
    value: {{ port }}
    description: |
      Port of your server

UPDATE examples

update

Update a server (Beta version)

UPDATE ovh.ssl_gateway.servers
SET 
address = '{{ address }}',
port = {{ port }}
WHERE 
id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Remove a server (Beta version)

DELETE FROM ovh.ssl_gateway.servers
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;