stephrobert.scaleway.instance_security_group_rule_info module – Gather information about Scaleway Instance security group rules

Note

This module is part of the stephrobert.scaleway collection (version 0.7.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install stephrobert.scaleway. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: stephrobert.scaleway.instance_security_group_rule_info.

New in stephrobert.scaleway 0.1.0

Synopsis

  • Get details of a security group rule with the specified ID.

  • List the rules of the a specified security group ID.

Requirements

The below requirements are needed on the host that executes this module.

  • scaleway >= 2.9.0

Parameters

Parameter

Comments

access_key

string

Scaleway API access key.

api_allow_insecure

boolean

Allow the API endpoint to be reached without verifying its TLS certificate.

Falls back to the Scaleway configuration file, then to false.

Choices:

  • false

  • true

api_timeout

integer

Seconds allowed for a single API call, connection and read.

Without a limit a silent connection would hang the module forever: the Scaleway SDK issues its requests with no timeout at all.

This bounds a single call, not a whole wait. Modules that can wait for a state bound the overall wait separately.

Default: 60

api_url

string

URL of the Scaleway API endpoint.

Point it at a local emulator to exercise a playbook without credentials.

Falls back to the Scaleway configuration file, then to https://api.scaleway.com. It carries no module default on purpose: a default is never unset, so it would always override the profile.

config_file

path

Path to the Scaleway configuration file.

organization_id

string

Default Organization ID used when an operation does not name one.

profile

string

Name of the profile to read in the Scaleway configuration file.

project_id

string

Default Project ID used when an operation does not name one.

secret_key

string

Scaleway API secret key.

security_group_id

string / required

UUID of the security group.

security_group_rule_id

string

UUID of the rule. (UUID format)

user_agent

string

Value of the User-Agent header sent to the API.

zone

string / required

The zone you want to target

Choices:

  • "fr-par-1"

  • "fr-par-2"

  • "fr-par-3"

  • "nl-ams-1"

  • "nl-ams-2"

  • "nl-ams-3"

  • "pl-waw-1"

  • "pl-waw-2"

  • "pl-waw-3"

  • "it-mil-1"

Attributes

Attribute

Support

Description

check_mode

Support: full

This module only reads, so check mode changes nothing about how it runs.

diff_mode

Support: none

This module changes nothing, so it has no difference to report.

Notes

Note

  • Every option can be set from its environment variable, respectively SCW_PROFILE, SCW_CONFIG_PATH, SCW_ACCESS_KEY, SCW_SECRET_KEY, SCW_API_URL, SCW_DEFAULT_ORGANIZATION_ID and SCW_DEFAULT_PROJECT_ID.

  • Module options take precedence over environment variables, which take precedence over the configuration file.

Examples

# This module only reads: it never changes anything, and check mode
# is native.
#
# `security_group_rule_id` decides which of the two reads runs: given, the
# module returns that one resource; omitted, it lists them all,
# walking every page rather than returning the first one in silence.

- name: Get rule
  stephrobert.scaleway.instance_security_group_rule_info:
    zone: fr-par-1
    security_group_id: 11111111-2222-3333-4444-555555555555
    security_group_rule_id: 11111111-2222-3333-4444-555555555555
  register: result
- name: List rules
  stephrobert.scaleway.instance_security_group_rule_info:
    zone: fr-par-1
    security_group_id: 11111111-2222-3333-4444-555555555555
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

rule

dictionary

Get details of a security group rule with the specified ID.

Returned: when security_group_rule_id is provided

action

string

Action to apply when the rule matches a packet.

Returned: when the API returns it

dest_port_from

integer

Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY.

Returned: when the API returns it

dest_port_to

integer

End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from.

Returned: when the API returns it

direction

string

Direction the rule applies to.

Returned: when the API returns it

editable

boolean

Indicates if this rule is editable. Rules with the value false will be ignored.

Returned: when the API returns it

id

string

Unique ID of the security group rule.

Returned: when the API returns it

ip_range

string

(IP network)

Returned: when the API returns it

position

integer

Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined.

Returned: when the API returns it

protocol

string

Protocol family this rule applies to.

Returned: when the API returns it

zone

string

The zone you want to target

Returned: when the API returns it

rules

list / elements=dictionary

List the rules of the a specified security group ID.

Returned: when security_group_rule_id is omitted

action

string

Action to apply when the rule matches a packet.

Returned: when the API returns it

dest_port_from

integer

Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY.

Returned: when the API returns it

dest_port_to

integer

End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from.

Returned: when the API returns it

direction

string

Direction the rule applies to.

Returned: when the API returns it

editable

boolean

Indicates if this rule is editable. Rules with the value false will be ignored.

Returned: when the API returns it

id

string

Unique ID of the security group rule.

Returned: when the API returns it

ip_range

string

(IP network)

Returned: when the API returns it

position

integer

Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined.

Returned: when the API returns it

protocol

string

Protocol family this rule applies to.

Returned: when the API returns it

zone

string

The zone you want to target

Returned: when the API returns it

Authors

  • Stéphane Robert (@stephrobert)