security_groups

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

Overview

Name	security_groups
Type	Resource
Id	ovh.public_cloud_network.security_groups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the security group
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the security group (wire: createdAt)
current_state	object	Current state of the security group (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the security group (wire: currentTasks)
resource_status	string	Security group readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the security group (wire: targetSpec)
updated_at	string (date-time)	Last update date of the security group (wire: updatedAt)

list

A Public Cloud security group

Name	Datatype	Description
id	string (uuid)	Unique identifier of the security group
checksum	string	Computed hash representing the current target specification value
created_at	string (date-time)	Creation date of the security group (wire: createdAt)
current_state	object	Current state of the security group (wire: currentState)
current_tasks	array	Ongoing asynchronous tasks related to the security group (wire: currentTasks)
resource_status	string	Security group readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Last target specification of the security group (wire: targetSpec)
updated_at	string (date-time)	Last update date of the security group (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	security_group_id, project_id		Returns the security group, including its rules and default egress rules.
list	select	project_id	x_pagination_cursor, x_pagination_size	Returns the security groups of the project.
create	insert	project_id, target_spec		Creates a security group with inline rules. OpenStack adds default egress rules automatically.
update	update	security_group_id, project_id, target_spec		Replaces the security group's name, description and rules as a whole.
delete	delete	security_group_id, project_id		Deletes the security group. Deletion is not blocked for a group still attached to interfaces or the project's default group.

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"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
security_group_id	string (uuid)	Security group ID (wire: securityGroupId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the security group, including its rules and default egress rules.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud_network.security_groups
WHERE security_group_id = '{{ security_group_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Returns the security groups of the project.

SELECT
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
FROM ovh.public_cloud_network.security_groups
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

Creates a security group with inline rules. OpenStack adds default egress rules automatically.

INSERT INTO ovh.public_cloud_network.security_groups (
target_spec,
project_id
)
SELECT 
'{{ target_spec }}' /* required */,
'{{ project_id }}'
RETURNING
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: security_groups
props:
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the security_groups resource.
  - name: target_spec
    description: |
      Desired target specification for the security group to create
    value:
      description: "{{ description }}"
      location:
        availabilityZone: "{{ availabilityZone }}"
        region: "{{ region }}"
      name: "{{ name }}"
      rules:
        - description: "{{ description }}"
          direction: "{{ direction }}"
          ethernetType: "{{ ethernetType }}"
          portRangeMax: {{ portRangeMax }}
          portRangeMin: {{ portRangeMin }}
          protocol: "{{ protocol }}"
          remoteGroup:
            id: "{{ id }}"
          remoteIpPrefix: "{{ remoteIpPrefix }}"

UPDATE examples

update

Replaces the security group's name, description and rules as a whole.

UPDATE ovh.public_cloud_network.security_groups
SET 
checksum = '{{ checksum }}',
target_spec = '{{ target_spec }}'
WHERE 
security_group_id = '{{ security_group_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
AND target_spec = '{{ target_spec }}' --required
RETURNING
id,
checksum,
created_at,
current_state,
current_tasks,
resource_status,
target_spec,
updated_at;

DELETE examples

delete

Deletes the security group. Deletion is not blocked for a group still attached to interfaces or the project's default group.

DELETE FROM ovh.public_cloud_network.security_groups
WHERE security_group_id = '{{ security_group_id }}' --required
AND project_id = '{{ project_id }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;