community.general.oneandone_public_ip module – Configure 1&1 public IPs
Note
This module is part of the community.general collection (version 9.5.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.oneandone_public_ip
.
Synopsis
Create, update, and remove public IPs. This module has a dependency on 1and1 >= 1.0.
Requirements
The below requirements are needed on the host that executes this module.
1and1
Parameters
Parameter |
Comments |
---|---|
Custom API URL. Overrides the ONEANDONE_API_URL environment variable. |
|
Authenticating API token provided by 1&1. |
|
ID of the datacenter where the IP will be created (only for unassigned IPs). Choices:
|
|
The ID of the public IP used with update and delete states. |
|
Reverse DNS name. maxLength=256 |
|
Define a public ip state to create, remove, or update. Choices:
|
|
Type of IP. Currently, only IPV4 is available. Choices:
|
|
wait for the instance to be in state ‘running’ before returning Choices:
|
|
Defines the number of seconds to wait when using the _wait_for methods Default: |
|
how long before wait gives up, in seconds Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create a public IP
community.general.oneandone_public_ip:
auth_token: oneandone_private_api_key
reverse_dns: example.com
datacenter: US
type: IPV4
- name: Update a public IP
community.general.oneandone_public_ip:
auth_token: oneandone_private_api_key
public_ip_id: public ip id
reverse_dns: secondexample.com
state: update
- name: Delete a public IP
community.general.oneandone_public_ip:
auth_token: oneandone_private_api_key
public_ip_id: public ip id
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about the public ip that was processed Returned: always Sample: |