backupftp_accesses

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

Overview

Name	backupftp_accesses
Type	Resource
Id	ovh.vps.backupftp_accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cifs	boolean	Whether to allow the CIFS (SMB) protocol for this ACL
ftp	boolean	Whether to allow the FTP protocol for this ACL
ip_block	string (ip-block)	The IP Block specific to this ACL (example: 192.0.2.0/24) (wire: ipBlock)
is_applied	boolean	Whether the rule has been applied on the Backup Ftp (wire: isApplied)
last_update	string (date-time)	Date of the last object modification (wire: lastUpdate)
nfs	boolean	Whether to allow the NFS protocol for this ACL

list

Backup Ftp ACL for this server and Backup Ftp

Name	Datatype	Description
cifs	boolean	Whether to allow the CIFS (SMB) protocol for this ACL
ftp	boolean	Whether to allow the FTP protocol for this ACL
ip_block	string (ip-block)	The IP Block specific to this ACL (example: 192.0.2.0/24) (wire: ipBlock)
is_applied	boolean	Whether the rule has been applied on the Backup Ftp (wire: isApplied)
last_update	string (date-time)	Date of the last object modification (wire: lastUpdate)
nfs	boolean	Whether to allow the NFS protocol for this ACL

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	ip_block, service_name		Returns the FTP, CIFS and NFS access settings of an IP block in the Backup FTP ACL of the VPS.
list	select	service_name	x_pagination_mode	Returns the IP blocks allowed to connect to the Backup FTP of the VPS.
create	insert	service_name, cifs, ip_block, nfs		Adds an IP block to the Backup FTP ACL of the VPS and returns the task that performs it.
update	update	ip_block, service_name		Updates the FTP, CIFS and NFS access settings of an IP block in the Backup FTP ACL of the VPS.
delete	delete	ip_block, service_name		Removes an IP block from the Backup FTP ACL of the VPS and returns the task that performs it.

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"}})
ip_block	string (ip-block)	Ip block (wire: ipBlock)
service_name	string	Service name (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

Returns the FTP, CIFS and NFS access settings of an IP block in the Backup FTP ACL of the VPS.

SELECT
cifs,
ftp,
ip_block,
is_applied,
last_update,
nfs
FROM ovh.vps.backupftp_accesses
WHERE ip_block = '{{ ip_block }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IP blocks allowed to connect to the Backup FTP of the VPS.

SELECT
cifs,
ftp,
ip_block,
is_applied,
last_update,
nfs
FROM ovh.vps.backupftp_accesses
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Adds an IP block to the Backup FTP ACL of the VPS and returns the task that performs it.

INSERT INTO ovh.vps.backupftp_accesses (
cifs,
ftp,
ip_block,
nfs,
service_name
)
SELECT 
{{ cifs }} /* required */,
{{ ftp }},
'{{ ip_block }}' /* required */,
{{ nfs }} /* required */,
'{{ service_name }}'
RETURNING
planned_intervention_id,
task_id,
comment,
done_date,
function,
last_update,
need_schedule,
note,
start_date,
status,
tags,
ticket_reference
;

Manifest

# Description fields are for documentation purposes
- name: backupftp_accesses
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the backupftp_accesses resource.
  - name: cifs
    value: {{ cifs }}
    description: |
      Whether to allow the CIFS (SMB) protocol for this ACL
  - name: ftp
    value: {{ ftp }}
    description: |
      Whether to allow the FTP protocol for this ACL
  - name: ip_block
    value: "{{ ip_block }}"
    description: |
      IP CIDR notation (e.g., 192.0.2.0/24)
  - name: nfs
    value: {{ nfs }}
    description: |
      Whether to allow the NFS protocol for this ACL

UPDATE examples

update

Updates the FTP, CIFS and NFS access settings of an IP block in the Backup FTP ACL of the VPS.

UPDATE ovh.vps.backupftp_accesses
SET 
cifs = {{ cifs }},
ftp = {{ ftp }},
nfs = {{ nfs }}
WHERE 
ip_block = '{{ ip_block }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Removes an IP block from the Backup FTP ACL of the VPS and returns the task that performs it.

DELETE FROM ovh.vps.backupftp_accesses
WHERE ip_block = '{{ ip_block }}' --required
AND service_name = '{{ service_name }}' --required
;