acls

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

Overview

Name	acls
Type	Resource
Id	ovh.dedicated_ceph.acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID of IP ACL
family	string	Family of IP ACL (IPV4, IPV6)
netmask	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0)
network	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0)

list

IP ACL

Name	Datatype	Description
id	integer	ID of IP ACL
family	string	Family of IP ACL (IPV4, IPV6)
netmask	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0)
network	string (ipv4)	IP address (e.g., 192.0.2.0) (example: 192.0.2.0)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	acl_id, service_name		Returns an IP ACL, which allows one network to connect to the cluster.
list	select	service_name		Returns the IP ACLs of the cluster. Only the networks listed in an ACL can connect to the cluster.
create	insert	service_name, acl_list		Creates one IP ACL for each network in aclList, to allow it to connect to the cluster. The ACLs also apply to CephFS.
delete	delete	acl_id, service_name		Deletes the IP ACL. Clients in its network can no longer connect to the cluster.

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
acl_id	integer	Acl ID (wire: aclId)
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"}})
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns an IP ACL, which allows one network to connect to the cluster.

SELECT
id,
family,
netmask,
network
FROM ovh.dedicated_ceph.acls
WHERE acl_id = '{{ acl_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IP ACLs of the cluster. Only the networks listed in an ACL can connect to the cluster.

SELECT
id,
family,
netmask,
network
FROM ovh.dedicated_ceph.acls
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Creates one IP ACL for each network in aclList, to allow it to connect to the cluster. The ACLs also apply to CephFS.

INSERT INTO ovh.dedicated_ceph.acls (
acl_list,
service_name
)
SELECT 
'{{ acl_list }}' /* required */,
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: acls
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the acls resource.
  - name: acl_list
    value:
      - "{{ acl_list }}"
    description: |
      List of new ACLs

DELETE examples

delete

Deletes the IP ACL. Clients in its network can no longer connect to the cluster.

DELETE FROM ovh.dedicated_ceph.acls
WHERE acl_id = '{{ acl_id }}' --required
AND service_name = '{{ service_name }}' --required
;