features_backup_ftp_accesses

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

Overview

Name	features_backup_ftp_accesses
Type	Resource
Id	ovh.dedicated_server.features_backup_ftp_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		Get a backup FTP ACL. Returns the protocols allowed for the IP block (FTP, NFS, CIFS), whether the rule is applied on the backup FTP space and its last update date.
list	select	service_name	x_pagination_mode	List backup FTP ACLs. Returns the IP blocks authorized on the backup FTP space. Get an ACL to see the protocols it allows: FTP, NFS and CIFS (SMB).
create	insert	service_name, cifs, ip_block, nfs		Create a backup FTP ACL. Authorizes an IP block on the backup FTP space with the chosen protocols and returns a task. At least one of ftp, nfs and cifs must be enabled; ftp is false when omitted. authorizableBlocks lists the eligible blocks.
update	update	ip_block, service_name		Update a backup FTP ACL. Updates the protocols allowed for the IP block: ftp, nfs and cifs. The change is applied asynchronously: isApplied stays false until it is in effect.
delete	delete	ip_block, service_name		Delete a backup FTP ACL. Revokes the access of the IP block to the backup FTP space and returns a task. The task carries the status of the revocation.

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)	The IP Block specific to this ACL (wire: ipBlock)
service_name	string	The internal name of your dedicated server (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 backup FTP ACL. Returns the protocols allowed for the IP block (FTP, NFS, CIFS), whether the rule is applied on the backup FTP space and its last update date.

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

list

List backup FTP ACLs. Returns the IP blocks authorized on the backup FTP space. Get an ACL to see the protocols it allows: FTP, NFS and CIFS (SMB).

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

INSERT examples

create

Create a backup FTP ACL. Authorizes an IP block on the backup FTP space with the chosen protocols and returns a task. At least one of ftp, nfs and cifs must be enabled; ftp is false when omitted. authorizableBlocks lists the eligible blocks.

INSERT INTO ovh.dedicated_server.features_backup_ftp_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,
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_backup_ftp_accesses
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the features_backup_ftp_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: |
      The IP Block specific to this ACL. It musts belong to your server.
  - name: nfs
    value: {{ nfs }}
    description: |
      Whether to allow the NFS protocol for this ACL

UPDATE examples

update

Update a backup FTP ACL. Updates the protocols allowed for the IP block: ftp, nfs and cifs. The change is applied asynchronously: isApplied stays false until it is in effect.

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

DELETE examples

delete

Delete a backup FTP ACL. Revokes the access of the IP block to the backup FTP space and returns a task. The task carries the status of the revocation.

DELETE FROM ovh.dedicated_server.features_backup_ftp_accesses
WHERE ip_block = '{{ ip_block }}' --required
AND service_name = '{{ service_name }}' --required
;