mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 18:31:25 -07:00
5589bcb659
Add attributes to oneandone, ovh, and rackspace modules (#5948)
Add attributes to oneandone, ovh, and rackspace modules.
(cherry picked from commit 6bd131f2fb)
203 lines
6.1 KiB
Python
203 lines
6.1 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright Ansible Project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: rax_mon_entity
|
|
short_description: Create or delete a Rackspace Cloud Monitoring entity
|
|
description:
|
|
- Create or delete a Rackspace Cloud Monitoring entity, which represents a device
|
|
to monitor. Entities associate checks and alarms with a target system and
|
|
provide a convenient, centralized place to store IP addresses. Rackspace
|
|
monitoring module flow | *rax_mon_entity* -> rax_mon_check ->
|
|
rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm.
|
|
- This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
|
|
- Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
|
|
attributes:
|
|
check_mode:
|
|
support: none
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
label:
|
|
type: str
|
|
description:
|
|
- Defines a name for this entity. Must be a non-empty string between 1 and
|
|
255 characters long.
|
|
required: true
|
|
state:
|
|
type: str
|
|
description:
|
|
- Ensure that an entity with this C(name) exists or does not exist.
|
|
choices: ["present", "absent"]
|
|
default: present
|
|
agent_id:
|
|
type: str
|
|
description:
|
|
- Rackspace monitoring agent on the target device to which this entity is
|
|
bound. Necessary to collect C(agent.) rax_mon_checks against this entity.
|
|
named_ip_addresses:
|
|
type: dict
|
|
default: {}
|
|
description:
|
|
- Hash of IP addresses that may be referenced by name by rax_mon_checks
|
|
added to this entity. Must be a dictionary of with keys that are names
|
|
between 1 and 64 characters long, and values that are valid IPv4 or IPv6
|
|
addresses.
|
|
metadata:
|
|
type: dict
|
|
default: {}
|
|
description:
|
|
- Hash of arbitrary C(name), C(value) pairs that are passed to associated
|
|
rax_mon_alarms. Names and values must all be between 1 and 255 characters
|
|
long.
|
|
author: Ash Wilson (@smashwilson)
|
|
extends_documentation_fragment:
|
|
- community.general.rackspace.openstack
|
|
- community.general.attributes
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Entity example
|
|
gather_facts: false
|
|
hosts: local
|
|
connection: local
|
|
tasks:
|
|
- name: Ensure an entity exists
|
|
community.general.rax_mon_entity:
|
|
credentials: ~/.rax_pub
|
|
state: present
|
|
label: my_entity
|
|
named_ip_addresses:
|
|
web_box: 192.0.2.4
|
|
db_box: 192.0.2.5
|
|
meta:
|
|
hurf: durf
|
|
register: the_entity
|
|
'''
|
|
|
|
try:
|
|
import pyrax
|
|
HAS_PYRAX = True
|
|
except ImportError:
|
|
HAS_PYRAX = False
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.rax import rax_argument_spec, rax_required_together, setup_rax_module
|
|
|
|
|
|
def cloud_monitoring(module, state, label, agent_id, named_ip_addresses,
|
|
metadata):
|
|
|
|
if len(label) < 1 or len(label) > 255:
|
|
module.fail_json(msg='label must be between 1 and 255 characters long')
|
|
|
|
changed = False
|
|
|
|
cm = pyrax.cloud_monitoring
|
|
if not cm:
|
|
module.fail_json(msg='Failed to instantiate client. This typically '
|
|
'indicates an invalid region or an incorrectly '
|
|
'capitalized region name.')
|
|
|
|
existing = []
|
|
for entity in cm.list_entities():
|
|
if label == entity.label:
|
|
existing.append(entity)
|
|
|
|
entity = None
|
|
|
|
if existing:
|
|
entity = existing[0]
|
|
|
|
if state == 'present':
|
|
should_update = False
|
|
should_delete = False
|
|
should_create = False
|
|
|
|
if len(existing) > 1:
|
|
module.fail_json(msg='%s existing entities have the label %s.' %
|
|
(len(existing), label))
|
|
|
|
if entity:
|
|
if named_ip_addresses and named_ip_addresses != entity.ip_addresses:
|
|
should_delete = should_create = True
|
|
|
|
# Change an existing Entity, unless there's nothing to do.
|
|
should_update = agent_id and agent_id != entity.agent_id or \
|
|
(metadata and metadata != entity.metadata)
|
|
|
|
if should_update and not should_delete:
|
|
entity.update(agent_id, metadata)
|
|
changed = True
|
|
|
|
if should_delete:
|
|
entity.delete()
|
|
else:
|
|
should_create = True
|
|
|
|
if should_create:
|
|
# Create a new Entity.
|
|
entity = cm.create_entity(label=label, agent=agent_id,
|
|
ip_addresses=named_ip_addresses,
|
|
metadata=metadata)
|
|
changed = True
|
|
else:
|
|
# Delete the existing Entities.
|
|
for e in existing:
|
|
e.delete()
|
|
changed = True
|
|
|
|
if entity:
|
|
entity_dict = {
|
|
"id": entity.id,
|
|
"name": entity.name,
|
|
"agent_id": entity.agent_id,
|
|
}
|
|
module.exit_json(changed=changed, entity=entity_dict)
|
|
else:
|
|
module.exit_json(changed=changed)
|
|
|
|
|
|
def main():
|
|
argument_spec = rax_argument_spec()
|
|
argument_spec.update(
|
|
dict(
|
|
state=dict(default='present', choices=['present', 'absent']),
|
|
label=dict(required=True),
|
|
agent_id=dict(),
|
|
named_ip_addresses=dict(type='dict', default={}),
|
|
metadata=dict(type='dict', default={})
|
|
)
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
required_together=rax_required_together()
|
|
)
|
|
|
|
if not HAS_PYRAX:
|
|
module.fail_json(msg='pyrax is required for this module')
|
|
|
|
state = module.params.get('state')
|
|
|
|
label = module.params.get('label')
|
|
agent_id = module.params.get('agent_id')
|
|
named_ip_addresses = module.params.get('named_ip_addresses')
|
|
metadata = module.params.get('metadata')
|
|
|
|
setup_rax_module(module, pyrax)
|
|
|
|
cloud_monitoring(module, state, label, agent_id, named_ip_addresses, metadata)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|