W3cubDocs

/Ansible

community.general.oneandone_private_network – Configure 1&1 private networking.

Note

This plugin is part of the community.general collection (version 3.8.1).

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.oneandone_private_network.

Synopsis

  • Create, remove, reconfigure, update a private network. This module has a dependency on 1and1 >= 1.0

Requirements

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

  • 1and1
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
add_members
list / elements=string
List of server identifiers (name or id) to be added to the private network.
api_url
string
Custom API URL. Overrides the ONEANDONE_API_URL environment variable.
auth_token
string
Authenticating API token provided by 1&1.
datacenter
string
    Choices:
  • US
  • ES
  • DE
  • GB
The identifier of the datacenter where the private network will be created
description
string
Set a description for the network.
name
string
Private network name used with present state. Used as identifier (id or name) when used with absent state.
network_address
string
Set a private network space, i.e. 192.168.1.0
private_network
string
The identifier (id or name) of the network used with update state.
remove_members
list / elements=string
List of server identifiers (name or id) to be removed from the private network.
state
string
    Choices:
  • present ←
  • absent
  • update
Define a network's state to create, remove, or update.
subnet_mask
string
Set the netmask for the private network, i.e. 255.255.255.0
wait
boolean
    Choices:
  • no
  • yes ←
wait for the instance to be in state 'running' before returning
wait_interval
integer
Default:
5
Defines the number of seconds to wait when using the _wait_for methods
wait_timeout
integer
Default:
600
how long before wait gives up, in seconds

Examples

- name: Create a private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    name: backup_network
    description: Testing creation of a private network with ansible
    network_address: 70.35.193.100
    subnet_mask: 255.0.0.0
    datacenter: US

- name: Destroy a private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: absent
    name: backup_network

- name: Modify the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    network_address: 192.168.2.0
    subnet_mask: 255.255.255.0

- name: Add members to the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    add_members:
     - server identifier (id or name)

- name: Remove members from the private network
  community.general.oneandone_private_network:
    auth_token: oneandone_private_api_key
    state: update
    private_network: backup_network
    remove_members:
     - server identifier (id or name)

Return Values

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

Key Returned Description
private_network
dictionary
always
Information about the private network.

Sample:
{"name": "backup_network", "id": "55726DEDA20C99CF6F2AF8F18CAC9963"}


Authors

  • Amel Ajdinovic (@aajdinov)
  • Ethan Devenport (@edevenport)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/oneandone_private_network_module.html