Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.oneandone_public_ip.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| 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 |
| ID of the datacenter where the IP will be created (only for unassigned IPs). |
| public_ip_id string | The ID of the public IP used with update and delete states. | |
| reverse_dns string | Reverse DNS name. maxLength=256 | |
| state string |
| Define a public ip state to create, remove, or update. |
| type string |
| Type of IP. Currently, only IPV4 is available. |
| wait boolean |
| 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 |
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| public_ip dictionary | always | Information about the public ip that was processed Sample: {"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"} |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/oneandone_public_ip_module.html