1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/rax_mon_entity.py

202 lines
5.9 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
#!/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
2020-03-09 10:11:07 +01:00
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
attributes:
check_mode:
support: none
diff_mode:
support: none
2020-03-09 10:11:07 +01:00
options:
label:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Defines a name for this entity. Must be a non-empty string between 1 and
255 characters long.
required: true
state:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Ensure that an entity with this C(name) exists or does not exist.
choices: ["present", "absent"]
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
default: present
2020-03-09 10:11:07 +01:00
agent_id:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: str
2020-03-09 10:11:07 +01:00
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:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: dict
2022-11-01 19:25:51 +01:00
default: {}
2020-03-09 10:11:07 +01:00
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:
Tidy up validate-modules ignores for rackspace modules (#1242) * fixed validation-modules for plugins/doc_fragments/rackspace.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cbs_attachments.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_database.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_cdb_user.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_nodes.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_clb_ssl.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_dns_record.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_facts.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_files_objects.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_identity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_keypair.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_meta.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_alarm.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_check.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_entity.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification_plan.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_mon_notification.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_network.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_queue.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_group.py * fixed validation-modules for plugins/modules/cloud/rackspace/rax_scaling_policy.py * Enabling validation-modules for rackspace modules * Removed test in rax.py * Added markup to items in list * rax_monm_check.py: moved choices doc to description for check_type As the argument_spec does not contain the "choices" spec, adjusting that in the docs * rax_monm_check.py: a number of things missing in docs, fixed
2020-11-08 09:44:28 +01:00
type: dict
2022-11-01 19:25:51 +01:00
default: {}
2020-03-09 10:11:07 +01:00
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
2020-03-09 10:11:07 +01:00
'''
EXAMPLES = '''
- name: Entity example
2022-09-06 20:42:17 +02:00
gather_facts: false
2020-03-09 10:11:07 +01:00
hosts: local
connection: local
tasks:
- name: Ensure an entity exists
community.general.rax_mon_entity:
2020-03-09 10:11:07 +01:00
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()