mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
New module: manage 1&1 public ip (cloud/oneandone/oneandone_public_ip) (#35079)
* Added firewall_policy, load_balancer, and monitoring_policy cloud modules for oneandone provider. * Updated OneAndOneResources class and argument specs for monitoring policy and load balancer. * Addressed ansible-test sanity pep8 and validate-modules errors. * Added oneandone_public_ip cloud module for oneandone cloud provider. Removed extra modules to adhere to one module per PR.
This commit is contained in:
Amel Ajdinovic
Adam Miller
parent
248c1e8b9f
commit
3381ff3ac9
2 changed files with 355 additions and 0 deletions
|
|
@ -192,6 +192,18 @@ def get_vpn(oneandone_conn, vpn, full_object=False):
|
|||
return _vpn['id']
|
||||
|
||||
|
||||
def get_public_ip(oneandone_conn, public_ip, full_object=False):
|
||||
"""
|
||||
Validates that the public ip exists by ID or a name.
|
||||
Returns the public ip if one was found.
|
||||
"""
|
||||
for _public_ip in oneandone_conn.list_public_ips(per_page=1000):
|
||||
if public_ip in (_public_ip['id'], _public_ip['ip']):
|
||||
if full_object:
|
||||
return _public_ip
|
||||
return _public_ip['id']
|
||||
|
||||
|
||||
def wait_for_resource_creation_completion(oneandone_conn,
|
||||
resource_type,
|
||||
resource_id,
|
||||
|
|
|
|||
343
lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py
Normal file
343
lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py
Normal file
|
|
@ -0,0 +1,343 @@
|
|||
#!/usr/bin/python
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_public_ip
|
||||
short_description: Configure 1&1 public IPs.
|
||||
description:
|
||||
- Create, update, and remove public IPs.
|
||||
This module has a dependency on 1and1 >= 1.0
|
||||
version_added: "2.5"
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Define a public ip state to create, remove, or update.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ "present", "absent", "update" ]
|
||||
auth_token:
|
||||
description:
|
||||
- Authenticating API token provided by 1&1.
|
||||
required: true
|
||||
api_url:
|
||||
description:
|
||||
- Custom API URL. Overrides the
|
||||
ONEANDONE_API_URL environement variable.
|
||||
required: false
|
||||
reverse_dns:
|
||||
description:
|
||||
- Reverse DNS name. maxLength=256
|
||||
required: false
|
||||
datacenter:
|
||||
description:
|
||||
- ID of the datacenter where the IP will be created (only for unassigned IPs).
|
||||
required: false
|
||||
type:
|
||||
description:
|
||||
- Type of IP. Currently, only IPV4 is available.
|
||||
choices: ["IPV4", "IPV6"]
|
||||
default: 'IPV4'
|
||||
required: false
|
||||
public_ip_id:
|
||||
description:
|
||||
- The ID of the public IP used with update and delete states.
|
||||
required: true
|
||||
wait:
|
||||
description:
|
||||
- wait for the instance to be in state 'running' before returning
|
||||
required: false
|
||||
default: "yes"
|
||||
choices: [ "yes", "no" ]
|
||||
wait_timeout:
|
||||
description:
|
||||
- how long before wait gives up, in seconds
|
||||
default: 600
|
||||
wait_interval:
|
||||
description:
|
||||
- Defines the number of seconds to wait when using the _wait_for methods
|
||||
default: 5
|
||||
|
||||
requirements:
|
||||
- "1and1"
|
||||
- "python >= 2.6"
|
||||
|
||||
author:
|
||||
- Amel Ajdinovic (@aajdinov)
|
||||
- Ethan Devenport (@edevenport)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
# Create a public IP.
|
||||
|
||||
- oneandone_public_ip:
|
||||
auth_token: oneandone_private_api_key
|
||||
reverse_dns: example.com
|
||||
datacenter: US
|
||||
type: IPV4
|
||||
|
||||
# Update a public IP.
|
||||
|
||||
- oneandone_public_ip:
|
||||
auth_token: oneandone_private_api_key
|
||||
public_ip_id: public ip id
|
||||
reverse_dns: secondexample.com
|
||||
state: update
|
||||
|
||||
|
||||
# Delete a public IP
|
||||
|
||||
- oneandone_public_ip:
|
||||
auth_token: oneandone_private_api_key
|
||||
public_ip_id: public ip id
|
||||
state: absent
|
||||
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
public_ip:
|
||||
description: Information about the public ip that was processed
|
||||
type: dict
|
||||
sample: '{"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}'
|
||||
returned: always
|
||||
'''
|
||||
|
||||
import os
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.oneandone import (
|
||||
get_datacenter,
|
||||
get_public_ip,
|
||||
OneAndOneResources,
|
||||
wait_for_resource_creation_completion
|
||||
)
|
||||
|
||||
HAS_ONEANDONE_SDK = True
|
||||
|
||||
try:
|
||||
import oneandone.client
|
||||
except ImportError:
|
||||
HAS_ONEANDONE_SDK = False
|
||||
|
||||
DATACENTERS = ['US', 'ES', 'DE', 'GB']
|
||||
|
||||
TYPES = ['IPV4', 'IPV6']
|
||||
|
||||
|
||||
def _check_mode(module, result):
|
||||
if module.check_mode:
|
||||
module.exit_json(
|
||||
changed=result
|
||||
)
|
||||
|
||||
|
||||
def create_public_ip(module, oneandone_conn):
|
||||
"""
|
||||
Create new public IP
|
||||
|
||||
module : AnsibleModule object
|
||||
oneandone_conn: authenticated oneandone object
|
||||
|
||||
Returns a dictionary containing a 'changed' attribute indicating whether
|
||||
any public IP was added.
|
||||
"""
|
||||
reverse_dns = module.params.get('reverse_dns')
|
||||
datacenter = module.params.get('datacenter')
|
||||
ip_type = module.params.get('type')
|
||||
wait = module.params.get('wait')
|
||||
wait_timeout = module.params.get('wait_timeout')
|
||||
wait_interval = module.params.get('wait_interval')
|
||||
|
||||
if datacenter is not None:
|
||||
datacenter_id = get_datacenter(oneandone_conn, datacenter)
|
||||
if datacenter_id is None:
|
||||
_check_mode(module, False)
|
||||
module.fail_json(
|
||||
msg='datacenter %s not found.' % datacenter)
|
||||
|
||||
try:
|
||||
_check_mode(module, True)
|
||||
public_ip = oneandone_conn.create_public_ip(
|
||||
reverse_dns=reverse_dns,
|
||||
ip_type=ip_type,
|
||||
datacenter_id=datacenter_id)
|
||||
|
||||
if wait:
|
||||
wait_for_resource_creation_completion(oneandone_conn,
|
||||
OneAndOneResources.public_ip,
|
||||
public_ip['id'],
|
||||
wait_timeout,
|
||||
wait_interval)
|
||||
public_ip = oneandone_conn.get_public_ip(public_ip['id'])
|
||||
|
||||
changed = True if public_ip else False
|
||||
|
||||
return (changed, public_ip)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
def update_public_ip(module, oneandone_conn):
|
||||
"""
|
||||
Update a public IP
|
||||
|
||||
module : AnsibleModule object
|
||||
oneandone_conn: authenticated oneandone object
|
||||
|
||||
Returns a dictionary containing a 'changed' attribute indicating whether
|
||||
any public IP was changed.
|
||||
"""
|
||||
reverse_dns = module.params.get('reverse_dns')
|
||||
public_ip_id = module.params.get('public_ip_id')
|
||||
wait = module.params.get('wait')
|
||||
wait_timeout = module.params.get('wait_timeout')
|
||||
wait_interval = module.params.get('wait_interval')
|
||||
|
||||
public_ip = get_public_ip(oneandone_conn, public_ip_id, True)
|
||||
if public_ip is None:
|
||||
_check_mode(module, False)
|
||||
module.fail_json(
|
||||
msg='public IP %s not found.' % public_ip_id)
|
||||
|
||||
try:
|
||||
_check_mode(module, True)
|
||||
public_ip = oneandone_conn.modify_public_ip(
|
||||
ip_id=public_ip['id'],
|
||||
reverse_dns=reverse_dns)
|
||||
|
||||
if wait:
|
||||
wait_for_resource_creation_completion(oneandone_conn,
|
||||
OneAndOneResources.public_ip,
|
||||
public_ip['id'],
|
||||
wait_timeout,
|
||||
wait_interval)
|
||||
public_ip = oneandone_conn.get_public_ip(public_ip['id'])
|
||||
|
||||
changed = True if public_ip else False
|
||||
|
||||
return (changed, public_ip)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
def delete_public_ip(module, oneandone_conn):
|
||||
"""
|
||||
Delete a public IP
|
||||
|
||||
module : AnsibleModule object
|
||||
oneandone_conn: authenticated oneandone object
|
||||
|
||||
Returns a dictionary containing a 'changed' attribute indicating whether
|
||||
any public IP was deleted.
|
||||
"""
|
||||
public_ip_id = module.params.get('public_ip_id')
|
||||
|
||||
public_ip = get_public_ip(oneandone_conn, public_ip_id, True)
|
||||
if public_ip is None:
|
||||
_check_mode(module, False)
|
||||
module.fail_json(
|
||||
msg='public IP %s not found.' % public_ip_id)
|
||||
|
||||
try:
|
||||
_check_mode(module, True)
|
||||
deleted_public_ip = oneandone_conn.delete_public_ip(
|
||||
ip_id=public_ip['id'])
|
||||
|
||||
changed = True if deleted_public_ip else False
|
||||
|
||||
return (changed, {
|
||||
'id': public_ip['id']
|
||||
})
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
auth_token=dict(
|
||||
type='str',
|
||||
default=os.environ.get('ONEANDONE_AUTH_TOKEN')),
|
||||
api_url=dict(
|
||||
type='str',
|
||||
default=os.environ.get('ONEANDONE_API_URL')),
|
||||
public_ip_id=dict(type='str'),
|
||||
reverse_dns=dict(type='str'),
|
||||
datacenter=dict(
|
||||
choices=DATACENTERS,
|
||||
default='US'),
|
||||
type=dict(
|
||||
choices=TYPES,
|
||||
default='IPV4'),
|
||||
wait=dict(type='bool', default=True),
|
||||
wait_timeout=dict(type='int', default=600),
|
||||
wait_interval=dict(type='int', default=5),
|
||||
state=dict(type='str', default='present', choices=['present', 'absent', 'update']),
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_ONEANDONE_SDK:
|
||||
module.fail_json(msg='1and1 required for this module')
|
||||
|
||||
if not module.params.get('auth_token'):
|
||||
module.fail_json(
|
||||
msg='auth_token parameter is required.')
|
||||
|
||||
if not module.params.get('api_url'):
|
||||
oneandone_conn = oneandone.client.OneAndOneService(
|
||||
api_token=module.params.get('auth_token'))
|
||||
else:
|
||||
oneandone_conn = oneandone.client.OneAndOneService(
|
||||
api_token=module.params.get('auth_token'), api_url=module.params.get('api_url'))
|
||||
|
||||
state = module.params.get('state')
|
||||
|
||||
if state == 'absent':
|
||||
if not module.params.get('public_ip_id'):
|
||||
module.fail_json(
|
||||
msg="'public_ip_id' parameter is required to delete a public ip.")
|
||||
try:
|
||||
(changed, public_ip) = delete_public_ip(module, oneandone_conn)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
elif state == 'update':
|
||||
if not module.params.get('public_ip_id'):
|
||||
module.fail_json(
|
||||
msg="'public_ip_id' parameter is required to update a public ip.")
|
||||
try:
|
||||
(changed, public_ip) = update_public_ip(module, oneandone_conn)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
elif state == 'present':
|
||||
try:
|
||||
(changed, public_ip) = create_public_ip(module, oneandone_conn)
|
||||
except Exception as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
module.exit_json(changed=changed, public_ip=public_ip)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue