community.general.scaleway_compute_private_network module – Scaleway compute - private network management

Note

This module is part of the community.general collection (version 7.5.2).

You might already have this collection installed if you are using the ansible package. 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 community.general.

To use it in a playbook, specify: community.general.scaleway_compute_private_network.

New in community.general 5.2.0

Synopsis

Aliases: cloud.scaleway.scaleway_compute_private_network

Parameters

Parameter

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Scaleway API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Scaleway OAuth token.

api_url

aliases: base_url

string

Scaleway API URL.

Default: "https://api.scaleway.com"

compute_id

string / required

ID of the compute instance (see community.general.scaleway_compute).

private_network_id

string / required

ID of the private network (see community.general.scaleway_private_network).

project

string / required

Project identifier.

query_parameters

dictionary

List of parameters passed to the query string.

Default: {}

region

string / required

Scaleway region to use (for example par1).

Choices:

  • "ams1"

  • "EMEA-NL-EVS"

  • "par1"

  • "EMEA-FR-PAR1"

  • "par2"

  • "EMEA-FR-PAR2"

  • "waw1"

  • "EMEA-PL-WAW1"

state

string

Indicate desired state of the VPC.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Validate SSL certs of the Scaleway API.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

Examples

- name: Plug a VM to a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: present
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
  register: nicsvpc_creation_task

- name: Unplug a VM from a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: absent
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"

Return Values

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

Key

Description

scaleway_compute_private_network

dictionary

Information on the VPC.

Returned: success when state=present

Sample: {"created_at": "2022-01-15T11:11:12.676445Z", "id": "12345678-f1e6-40ec-83e5-12345d67ed89", "name": "network", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "tags": ["tag1", "tag2", "tag3", "tag4", "tag5"], "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2"}

Authors

  • Pascal MANGIN (@pastral)