netapp_share_acls

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

Overview

Name	netapp_share_acls
Type	Resource
Id	ovh.storage.netapp_share_acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Rule ID
access_level	string	Rule access level (ro, rw) (wire: accessLevel)
access_to	string	Rule destination (wire: accessTo)
access_type	string	Rule access type (ip) (wire: accessType)
created_at	string (date-time)	Rule creation date (wire: createdAt)
status	string	Rule status (active, applying, denying, error, queued_to_apply, queued_to_deny)

list

A share ACL rule

Name	Datatype	Description
id	string (uuid)	Rule ID
access_level	string	Rule access level (ro, rw) (wire: accessLevel)
access_to	string	Rule destination (wire: accessTo)
access_type	string	Rule access type (ip) (wire: accessType)
created_at	string (date-time)	Rule creation date (wire: createdAt)
status	string	Rule status (active, applying, denying, error, queued_to_apply, queued_to_deny)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	acl_rule_id, service_name, share_id		Returns the ACL and its status. An ACL in error is not applied to the share: delete it and create it again.
list	select	service_name, share_id		Returns the ACLs of the share, including those still being applied or removed. Check the status of each ACL to know whether it is in effect.
create	insert	service_name, share_id, access_level, access_to		Grants an IPv4 address or IPv4 CIDR block read-only or read-write access to the share. Creation is asynchronous: the ACL is returned with status queued_to_apply, follow its status until active. The call is rejected while the share is being created, resized, reverted or replicated.
delete	delete	acl_rule_id, service_name, share_id		Revokes access to the share. Clients already mounting the share using it lose access. Deletion is asynchronous: the ACL stays listed with status queued_to_deny or denying until it is removed.

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_rule_id	string (uuid)	Acl rule ID (wire: aclRuleId)
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 (uuid)	Service name (wire: serviceName)
share_id	string (uuid)	Share ID (wire: shareId)

SELECT examples

get

Returns the ACL and its status. An ACL in error is not applied to the share: delete it and create it again.

SELECT
id,
access_level,
access_to,
access_type,
created_at,
status
FROM ovh.storage.netapp_share_acls
WHERE acl_rule_id = '{{ acl_rule_id }}' -- required
AND service_name = '{{ service_name }}' -- required
AND share_id = '{{ share_id }}' -- required
;

list

Returns the ACLs of the share, including those still being applied or removed. Check the status of each ACL to know whether it is in effect.

SELECT
id,
access_level,
access_to,
access_type,
created_at,
status
FROM ovh.storage.netapp_share_acls
WHERE service_name = '{{ service_name }}' -- required
AND share_id = '{{ share_id }}' -- required
;

INSERT examples

create

Grants an IPv4 address or IPv4 CIDR block read-only or read-write access to the share. Creation is asynchronous: the ACL is returned with status queued_to_apply, follow its status until active. The call is rejected while the share is being created, resized, reverted or replicated.

INSERT INTO ovh.storage.netapp_share_acls (
access_level,
access_to,
service_name,
share_id
)
SELECT 
'{{ access_level }}' /* required */,
'{{ access_to }}' /* required */,
'{{ service_name }}',
'{{ share_id }}'
RETURNING
id,
access_level,
access_to,
access_type,
created_at,
status
;

Manifest

# Description fields are for documentation purposes
- name: netapp_share_acls
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the netapp_share_acls resource.
  - name: share_id
    value: "{{ share_id }}"
    description: Required parameter for the netapp_share_acls resource.
  - name: access_level
    value: "{{ access_level }}"
    description: |
      Rule access level
    valid_values: ['ro', 'rw']
  - name: access_to
    value: "{{ access_to }}"
    description: |
      Rule destination

DELETE examples

delete

Revokes access to the share. Clients already mounting the share using it lose access. Deletion is asynchronous: the ACL stays listed with status queued_to_deny or denying until it is removed.

DELETE FROM ovh.storage.netapp_share_acls
WHERE acl_rule_id = '{{ acl_rule_id }}' --required
AND service_name = '{{ service_name }}' --required
AND share_id = '{{ share_id }}' --required
;