internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 22:02:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reformat everything.

Browse Source
This commit is contained in:
Felix Fontein
2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
plugins/inventory/icinga2.py
View File

@@ -104,12 +104,11 @@ from ansible_collections.community.general.plugins.plugin_utils.unsafe import ma
class InventoryModule(BaseInventoryPlugin, Constructable):
''' Host inventory parser for ansible using Icinga2 as source. '''
"""Host inventory parser for ansible using Icinga2 as source."""
NAME = 'community.general.icinga2'
NAME = "community.general.icinga2"
def __init__(self):
super().__init__()
# from config
@@ -127,7 +126,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
def verify_file(self, path):
valid = False
if super().verify_file(path):
if path.endswith(('icinga2.yaml', 'icinga2.yml')):
if path.endswith(("icinga2.yaml", "icinga2.yml")):
valid = True
else:
self.display.vvv('Skipping due to inventory source not ending in "icinga2.yaml" nor "icinga2.yml"')
@@ -135,28 +134,28 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
def _api_connect(self):
self.headers = {
'User-Agent': "ansible-icinga2-inv",
'Accept': "application/json",
"User-Agent": "ansible-icinga2-inv",
"Accept": "application/json",
}
api_status_url = f"{self.icinga2_url}/status"
request_args = {
'headers': self.headers,
'url_username': self.icinga2_user,
'url_password': self.icinga2_password,
'validate_certs': self.ssl_verify
"headers": self.headers,
"url_username": self.icinga2_user,
"url_password": self.icinga2_password,
"validate_certs": self.ssl_verify,
}
open_url(api_status_url, **request_args)
def _post_request(self, request_url, data=None):
self.display.vvv(f"Requested URL: {request_url}")
request_args = {
'headers': self.headers,
'url_username': self.icinga2_user,
'url_password': self.icinga2_password,
'validate_certs': self.ssl_verify
"headers": self.headers,
"url_username": self.icinga2_user,
"url_password": self.icinga2_password,
"validate_certs": self.ssl_verify,
}
if data is not None:
request_args['data'] = json.dumps(data)
request_args["data"] = json.dumps(data)
self.display.vvv(f"Request Args: {request_args}")
try:
response = open_url(request_url, **request_args)
@@ -166,51 +165,60 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
self.display.vvv(f"Error returned: {error_body}")
except Exception:
error_body = {"status": None}
if e.code == 404 and error_body.get('status') == "No objects found.":
if e.code == 404 and error_body.get("status") == "No objects found.":
raise AnsibleParserError("Host filter returned no data. Please confirm your host_filter value is valid")
raise AnsibleParserError(f"Unexpected data returned: {e} -- {error_body}")
response_body = response.read()
json_data = json.loads(response_body.decode('utf-8'))
json_data = json.loads(response_body.decode("utf-8"))
self.display.vvv(f"Returned Data: {json.dumps(json_data, indent=4, sort_keys=True)}")
if 200 <= response.status <= 299:
return json_data
if response.status == 404 and json_data['status'] == "No objects found.":
raise AnsibleParserError(
f"API returned no data -- Response: {response.status} - {json_data['status']}")
if response.status == 404 and json_data["status"] == "No objects found.":
raise AnsibleParserError(f"API returned no data -- Response: {response.status} - {json_data['status']}")
if response.status == 401:
raise AnsibleParserError(
f"API was unable to complete query -- Response: {response.status} - {json_data['status']}")
f"API was unable to complete query -- Response: {response.status} - {json_data['status']}"
)
if response.status == 500:
raise AnsibleParserError(
f"API Response - {json_data['status']} - {json_data['errors']}")
raise AnsibleParserError(
f"Unexpected data returned - {json_data['status']} - {json_data['errors']}")
raise AnsibleParserError(f"API Response - {json_data['status']} - {json_data['errors']}")
raise AnsibleParserError(f"Unexpected data returned - {json_data['status']} - {json_data['errors']}")
def _query_hosts(self, hosts=None, attrs=None, joins=None, host_filter=None):
query_hosts_url = f"{self.icinga2_url}/objects/hosts"
self.headers['X-HTTP-Method-Override'] = 'GET'
self.headers["X-HTTP-Method-Override"] = "GET"
data_dict = dict()
if hosts:
data_dict['hosts'] = hosts
data_dict["hosts"] = hosts
if attrs is not None:
data_dict['attrs'] = attrs
data_dict["attrs"] = attrs
if joins is not None:
data_dict['joins'] = joins
data_dict["joins"] = joins
if host_filter is not None:
data_dict['filter'] = host_filter.replace("\\\"", "\"")
data_dict["filter"] = host_filter.replace('\\"', '"')
self.display.vvv(host_filter)
host_dict = self._post_request(query_hosts_url, data_dict)
return host_dict['results']
return host_dict["results"]
def get_inventory_from_icinga(self):
"""Query for all hosts """
"""Query for all hosts"""
self.display.vvv("Querying Icinga2 for inventory")
query_args = {
"attrs": ["address", "address6", "name", "display_name", "state_type", "state", "templates", "groups", "vars", "zone"],
"attrs": [
"address",
"address6",
"name",
"display_name",
"state_type",
"state",
"templates",
"groups",
"vars",
"zone",
],
}
if self.host_filter is not None:
query_args['host_filter'] = self.host_filter
query_args["host_filter"] = self.host_filter
# Icinga2 API Call
results_json = self._query_hosts(**query_args)
# Manipulate returned API data to Ansible inventory spec
@@ -218,10 +226,10 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
return ansible_inv
def _apply_constructable(self, name, variables):
strict = self.get_option('strict')
self._add_host_to_composed_groups(self.get_option('groups'), variables, name, strict=strict)
self._add_host_to_keyed_groups(self.get_option('keyed_groups'), variables, name, strict=strict)
self._set_composite_vars(self.get_option('compose'), variables, name, strict=strict)
strict = self.get_option("strict")
self._add_host_to_composed_groups(self.get_option("groups"), variables, name, strict=strict)
self._add_host_to_keyed_groups(self.get_option("keyed_groups"), variables, name, strict=strict)
self._set_composite_vars(self.get_option("compose"), variables, name, strict=strict)
def _populate(self):
groups = self._to_json(self.get_inventory_from_icinga())
@@ -235,58 +243,55 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
"""Convert Icinga2 API data to JSON format for Ansible"""
groups_dict = {"_meta": {"hostvars": {}}}
for entry in json_data:
host_attrs = make_unsafe(entry['attrs'])
host_attrs = make_unsafe(entry["attrs"])
if self.inventory_attr == "name":
host_name = make_unsafe(entry.get('name'))
host_name = make_unsafe(entry.get("name"))
if self.inventory_attr == "address":
# When looking for address for inventory, if missing fallback to object name
if host_attrs.get('address', '') != '':
host_name = make_unsafe(host_attrs.get('address'))
if host_attrs.get("address", "") != "":
host_name = make_unsafe(host_attrs.get("address"))
else:
host_name = make_unsafe(entry.get('name'))
host_name = make_unsafe(entry.get("name"))
if self.inventory_attr == "display_name":
host_name = host_attrs.get('display_name')
if host_attrs['state'] == 0:
host_attrs['state'] = 'on'
host_name = host_attrs.get("display_name")
if host_attrs["state"] == 0:
host_attrs["state"] = "on"
else:
host_attrs['state'] = 'off'
host_attrs["state"] = "off"
self.inventory.add_host(host_name)
if self.group_by_hostgroups:
host_groups = host_attrs.get('groups')
host_groups = host_attrs.get("groups")
for group in host_groups:
if group not in self.inventory.groups.keys():
self.inventory.add_group(group)
self.inventory.add_child(group, host_name)
# If the address attribute is populated, override ansible_host with the value
if host_attrs.get('address') != '':
self.inventory.set_variable(host_name, 'ansible_host', host_attrs.get('address'))
self.inventory.set_variable(host_name, 'hostname', make_unsafe(entry.get('name')))
self.inventory.set_variable(host_name, 'display_name', host_attrs.get('display_name'))
self.inventory.set_variable(host_name, 'state',
host_attrs['state'])
self.inventory.set_variable(host_name, 'state_type',
host_attrs['state_type'])
if host_attrs.get("address") != "":
self.inventory.set_variable(host_name, "ansible_host", host_attrs.get("address"))
self.inventory.set_variable(host_name, "hostname", make_unsafe(entry.get("name")))
self.inventory.set_variable(host_name, "display_name", host_attrs.get("display_name"))
self.inventory.set_variable(host_name, "state", host_attrs["state"])
self.inventory.set_variable(host_name, "state_type", host_attrs["state_type"])
# Adds all attributes to a variable 'icinga2_attributes'
construct_vars = dict(self.inventory.get_host(host_name).get_vars())
construct_vars['icinga2_attributes'] = host_attrs
construct_vars["icinga2_attributes"] = host_attrs
self._apply_constructable(host_name, construct_vars)
return groups_dict
def parse(self, inventory, loader, path, cache=True):
super().parse(inventory, loader, path)
# read config from file, this sets 'options'
self._read_config_data(path)
# Store the options from the YAML file
self.icinga2_url = self.get_option('url')
self.icinga2_user = self.get_option('user')
self.icinga2_password = self.get_option('password')
self.ssl_verify = self.get_option('validate_certs')
self.host_filter = self.get_option('host_filter')
self.inventory_attr = self.get_option('inventory_attr')
self.group_by_hostgroups = self.get_option('group_by_hostgroups')
self.icinga2_url = self.get_option("url")
self.icinga2_user = self.get_option("user")
self.icinga2_password = self.get_option("password")
self.ssl_verify = self.get_option("validate_certs")
self.host_filter = self.get_option("host_filter")
self.inventory_attr = self.get_option("inventory_attr")
self.group_by_hostgroups = self.get_option("group_by_hostgroups")
if self.templar.is_template(self.icinga2_url):
self.icinga2_url = self.templar.template(variable=self.icinga2_url)