network_acls

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

Overview

Name	network_acls
Type	Resource
Id	ovh.cluster_hadoop.network_acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
block	string (ip-block)	IP Block to allow (example: 192.0.2.0/24)
description	string	description of this ACL
state	string	State of the NetworkAcl. (disabled, enabled, pending)

list

ACL for allowing ip blocks to access to your cluster

Name	Datatype	Description
block	string (ip-block)	IP Block to allow (example: 192.0.2.0/24)
description	string	description of this ACL
state	string	State of the NetworkAcl. (disabled, enabled, pending)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	block, service_name		Get this object properties
list	select	service_name	x_pagination_mode	Network ACL associated with this Hadoop Cluster
create	insert	service_name		Add an ACL to your cluster
update	update	block, service_name		Alter this object properties
delete	delete	block, service_name		Remove this ACL

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"}})
block	string (ip-block)	IP Block to allow
service_name	string	The internal name of your cluster (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 this object properties

SELECT
block,
description,
state
FROM ovh.cluster_hadoop.network_acls
WHERE block = '{{ block }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Network ACL associated with this Hadoop Cluster

SELECT
block,
description,
state
FROM ovh.cluster_hadoop.network_acls
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an ACL to your cluster

INSERT INTO ovh.cluster_hadoop.network_acls (
block,
description,
service_name
)
SELECT 
'{{ block }}',
'{{ description }}',
'{{ service_name }}'
RETURNING
name,
task_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: network_acls
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the network_acls resource.
  - name: block
    value: "{{ block }}"
    description: |
      IP block to allow
  - name: description
    value: "{{ description }}"
    description: |
      Free description

UPDATE examples

update

Alter this object properties

UPDATE ovh.cluster_hadoop.network_acls
SET 
description = '{{ description }}'
WHERE 
block = '{{ block }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Remove this ACL

DELETE FROM ovh.cluster_hadoop.network_acls
WHERE block = '{{ block }}' --required
AND service_name = '{{ service_name }}' --required
;