own_logs_user_logs

Creates, updates, deletes, gets or lists an own_logs_user_logs resource.

Overview

Name	own_logs_user_logs
Type	Resource
Id	ovh.hosting_web.own_logs_user_logs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
own_logs_id	integer	OwnLogs where this userLogs will be enable. Default : main domain ownlogs (wire: ownLogsId)
task_id	integer	The task ID working on this userLogs (wire: taskId)
creation_date	string (date-time)	Date of the user creation (wire: creationDate)
description	string	Description field for you
login	string	The userLogs login used to connect to logs.ovh.net
status	string	Status of this userLogs (created, creating, deleting, updating)

list

Hosting users logs

Name	Datatype	Description
own_logs_id	integer	OwnLogs where this userLogs will be enable. Default : main domain ownlogs (wire: ownLogsId)
task_id	integer	The task ID working on this userLogs (wire: taskId)
creation_date	string (date-time)	Date of the user creation (wire: creationDate)
description	string	Description field for you
login	string	The userLogs login used to connect to logs.ovh.net
status	string	Status of this userLogs (created, creating, deleting, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, login, service_name		Get a log user. Returns the login, description, status and creation date of the log user, and the own logs it can access.
list	select	id, service_name	login, x_pagination_mode	List log users. Returns the logins of the users allowed to access the logs interface. Filter them by login.
create	insert	id, service_name, description, login, password		Create a log user. Creates a user allowed to access the logs interface. Without ownLogsId, the user accesses the logs of the main domain.
update	update	id, login, service_name		Update a log user. Updates the description of the log user. The login and the own logs it can access cannot be changed.
delete	delete	id, login, service_name		Delete a log user. Deletes the log user, who can no longer access the logs interface at logs.ovh.net with its login.
change_password	exec	id, login, serviceName, password		Change a log user password. Changes the password the log user enters to access the logs interface at logs.ovh.net.

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 the object
login	string	The userLogs login used to connect to logs.ovh.net
serviceName	string	The internal name of your hosting
service_name	string	The internal name of your hosting (wire: serviceName)
login	string	Filter the value of login property (like)
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 log user. Returns the login, description, status and creation date of the log user, and the own logs it can access.

SELECT
own_logs_id,
task_id,
creation_date,
description,
login,
status
FROM ovh.hosting_web.own_logs_user_logs
WHERE id = '{{ id }}' -- required
AND login = '{{ login }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List log users. Returns the logins of the users allowed to access the logs interface. Filter them by login.

SELECT
own_logs_id,
task_id,
creation_date,
description,
login,
status
FROM ovh.hosting_web.own_logs_user_logs
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND login = '{{ login }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a log user. Creates a user allowed to access the logs interface. Without ownLogsId, the user accesses the logs of the main domain.

INSERT INTO ovh.hosting_web.own_logs_user_logs (
description,
login,
own_logs_id,
password,
id,
service_name
)
SELECT 
'{{ description }}' /* required */,
'{{ login }}' /* required */,
{{ own_logs_id }},
'{{ password }}' /* required */,
'{{ id }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: own_logs_user_logs
props:
  - name: id
    value: {{ id }}
    description: Required parameter for the own_logs_user_logs resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the own_logs_user_logs resource.
  - name: description
    value: "{{ description }}"
    description: |
      Description field for you
  - name: login
    value: "{{ login }}"
    description: |
      The userLogs login used to connect to logs.ovh.net
  - name: own_logs_id
    value: {{ own_logs_id }}
    description: |
      OwnLogs where this userLogs will be enable. Default : main domain ownlogs
  - name: password
    value: "{{ password }}"
    description: |
      The new userLogs password

UPDATE examples

update

Update a log user. Updates the description of the log user. The login and the own logs it can access cannot be changed.

UPDATE ovh.hosting_web.own_logs_user_logs
SET 
description = '{{ description }}'
WHERE 
id = '{{ id }}' --required
AND login = '{{ login }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a log user. Deletes the log user, who can no longer access the logs interface at logs.ovh.net with its login.

DELETE FROM ovh.hosting_web.own_logs_user_logs
WHERE id = '{{ id }}' --required
AND login = '{{ login }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change a log user password. Changes the password the log user enters to access the logs interface at logs.ovh.net.

EXEC ovh.hosting_web.own_logs_user_logs.change_password 
@id='{{ id }}' --required, 
@login='{{ login }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;