fb-vmware 1.7.1__py3-none-any.whl → 1.8.1__py3-none-any.whl

fb_vmware/app/get_rpool_list.py

@@ -0,0 +1,386 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@summary: Print a list of all resouce pools in a VMware vSphere.
+
+@author: Frank Brehm
+@contact: frank@brehm-online.com
+@copyright: © 2026 by Frank Brehm, Berlin
+"""
+from __future__ import absolute_import, print_function
+
+# Standard modules
+import locale
+import logging
+import pathlib
+import sys
+from operator import attrgetter
+
+# Third party modules
+from babel.numbers import format_decimal
+
+from fb_tools.common import pp
+from fb_tools.spinner import Spinner
+from fb_tools.xlate import format_list
+
+from rich import box
+from rich.table import Table
+from rich.text import Text
+
+# Own modules
+from . import BaseVmwareApplication, VmwareAppError
+from .. import __version__ as GLOBAL_VERSION
+from ..errors import VSphereExpectedError
+from ..xlate import XLATOR
+
+__version__ = "1.1.1"
+LOG = logging.getLogger(__name__)
+
+_ = XLATOR.gettext
+ngettext = XLATOR.ngettext
+
+
+# =============================================================================
+class GetResPoolAppError(VmwareAppError):
+    """Base exception class for all exceptions in this application."""
+
+    pass
+
+
+# =============================================================================
+class GetResPoolListApplication(BaseVmwareApplication):
+    """Class for the application object."""
+
+    avail_sort_keys = ("name", "vsphere", "dc_name")
+    default_sort_keys = ["vsphere", "dc_name", "name"]
+
+    # -------------------------------------------------------------------------
+    def __init__(
+        self,
+        appname=None,
+        verbose=0,
+        version=GLOBAL_VERSION,
+        base_dir=None,
+        initialized=False,
+        usage=None,
+        description=None,
+        argparse_epilog=None,
+        argparse_prefix_chars="-",
+        env_prefix=None,
+    ):
+        """Initialize a GetResPoolListApplication object."""
+        desc = _(
+            "Tries to get a list of all resource pools (a.k.a. computing resource and cluster "
+            "computing resource) in VMware vSphere and print it out."
+        )
+
+        self.sort_keys = self.default_sort_keys
+
+        super(GetResPoolListApplication, self).__init__(
+            appname=appname,
+            verbose=verbose,
+            version=version,
+            base_dir=base_dir,
+            description=desc,
+            initialized=False,
+        )
+
+        self.initialized = True
+
+    # -------------------------------------------------------------------------
+    def init_arg_parser(self):
+        """Public available method to initiate the argument parser."""
+        output_options = self.arg_parser.add_argument_group(_("Output options"))
+
+        output_options.add_argument(
+            "-S",
+            "--sort",
+            metavar="KEY",
+            nargs="+",
+            dest="sort_keys",
+            choices=self.avail_sort_keys,
+            help=_(
+                "The keys for sorting the output. Available keys are: {avail}. "
+                "The default sorting keys are: {default}."
+            ).format(
+                avail=format_list(self.avail_sort_keys, do_repr=True),
+                default=format_list(self.default_sort_keys, do_repr=True),
+            ),
+        )
+
+        super(GetResPoolListApplication, self).init_arg_parser()
+
+    # -------------------------------------------------------------------------
+    def perform_arg_parser(self):
+        """Evaluate command line parameters."""
+        super(GetResPoolListApplication, self).perform_arg_parser()
+
+        if self.args.sort_keys:
+            self.sort_keys = self.args.sort_keys
+
+    # -------------------------------------------------------------------------
+    def _run(self):
+
+        LOG.debug(_("Starting {a!r}, version {v!r} ...").format(a=self.appname, v=self.version))
+
+        ret = 0
+        try:
+            ret = self.get_all_resource_pools()
+        except VSphereExpectedError as e:
+            LOG.error(str(e))
+            self.exit(6)
+        finally:
+            self.cleaning_up()
+
+        self.exit(ret)
+
+    # -------------------------------------------------------------------------
+    def get_all_resource_pools(self):
+        """Collect all resource pools, a.k.a. (cluster) computing resources."""
+        ret = 0
+        all_rpools = []
+
+        if self.verbose or self.quiet:
+            for vsphere_name in self.vsphere:
+                all_rpools += self.get_resource_pools(vsphere_name)
+        else:
+            spin_prompt = _("Getting all vSphere hosts ...") + " "
+            spinner_name = self.get_random_spinner_name()
+            with Spinner(spin_prompt, spinner_name):
+                for vsphere_name in self.vsphere:
+                    all_rpools += self.get_resource_pools(vsphere_name)
+            sys.stdout.write(" " * len(spin_prompt))
+            sys.stdout.write("\r")
+            sys.stdout.flush()
+
+        all_rpools.sort(key=attrgetter(*self.sort_keys))
+
+        if len(all_rpools):
+            out_list = []
+            out = ""
+            if self.verbose == 2:
+                LOG.debug(_("First computing resource:") + "\n" + pp(all_rpools[0].as_dict()))
+                for rpool in all_rpools:
+                    out_list.append(
+                        f" * Vsphere {rpool.vsphere:<10} - DC {rpool.dc_name:<12} - {rpool.name}"
+                    )
+                out = "\n".join(out_list)
+            elif self.verbose > 2:
+                for rpool in all_rpools:
+                    out_list.append(rpool.as_dict())
+                out = pp(out_list)
+            if self.verbose >= 2:
+                LOG.debug("All computing resources:\n{}".format(out))
+
+            self.print_rpools(all_rpools)
+        else:
+            LOG.error(_("Did not found any resource pools or cluster resource pools."))
+            if not self.quiet:
+                print()
+            ret = 3
+
+        return ret
+
+    # -------------------------------------------------------------------------
+    def get_resource_pools(self, vsphere_name):
+        """Get all host of all (cluster) computing resources in a VMware vSphere."""
+        clusters = []
+
+        vsphere = self.vsphere[vsphere_name]
+
+        vsphere.get_clusters(vsphere_name=vsphere_name)
+
+        for cluster in sorted(vsphere.clusters):
+            clusters.append(cluster)
+
+        return clusters
+
+    # -------------------------------------------------------------------------
+    def print_rpools(self, rpools):
+        """Print on STDOUT all information about cluster) computing resources."""
+        show_header = True
+        show_footer = True
+        table_title = _("All compute resources and cluster compute resources") + "\n"
+        box_style = box.ROUNDED
+
+        if self.quiet:
+            show_header = False
+            show_footer = False
+            table_title = None
+            box_style = None
+
+        if self.quiet:
+            caption = None
+        else:
+            count = len(rpools)
+            if count:
+                caption = "\n" + ngettext(
+                    "Found one compute resource.",
+                    "Found {} compute resources.",
+                    count,
+                ).format(count)
+            else:
+                caption = "\n" + _("Found no compute resources.")
+
+        totals = self._get_totals(rpools)
+
+        table = Table(
+            title=table_title,
+            title_style="bold cyan",
+            caption=caption,
+            caption_style="default on default",
+            caption_justify="left",
+            box=box_style,
+            show_header=show_header,
+            show_footer=show_footer,
+        )
+
+        table.add_column(header=_("vSphere"), footer=_("Total:"))
+        table.add_column(header=_("Data Center"), footer="")
+        table.add_column(header=_("Name"), footer="")
+        table.add_column(header=_("Cluster"), footer="")
+        table.add_column(header=_("Pool name"), footer="")
+        table.add_column(
+            header=_("Hosts total"),
+            justify="right",
+            footer=self._prepare_number(totals["hosts_total"], warn_on_value1=True),
+        )
+        table.add_column(
+            header=_("Hosts available"),
+            justify="right",
+            footer=self._prepare_number(
+                totals["hosts_avail"],
+                warn_on_value1=True,
+                compare_val=totals["hosts_total"],
+            ),
+        )
+        table.add_column(
+            header=_("CPU cores"),
+            justify="right",
+            footer=self._prepare_number(totals["cpu_cores"]),
+        )
+        table.add_column(
+            header=_("CPU threads"),
+            justify="right",
+            footer=self._prepare_number(totals["cpu_threads"]),
+        )
+        table.add_column(
+            header=_("Memory total"),
+            justify="right",
+            footer=self._prepare_number(totals["mem_total"]),
+        )
+        table.add_column(
+            header=_("Memory available"),
+            justify="right",
+            footer=self._prepare_number(totals["mem_avail"], compare_val=totals["mem_total"]),
+        )
+
+        for rpool in rpools:
+            row = []
+            row.append(rpool.vsphere)
+            row.append(rpool.dc_name)
+            row.append(rpool.name)
+
+            is_cluster = Text(_("Yes"), style="bold green")
+            if rpool.standalone:
+                is_cluster = Text(_("No"), style="green")
+
+            row.append(is_cluster)
+            row.append(rpool.base_resource_pool_name)
+            row.append(self._prepare_number(rpool.hosts_total, warn_on_value1=True))
+            row.append(
+                self._prepare_number(
+                    rpool.hosts_effective,
+                    warn_on_value1=True,
+                    compare_val=rpool.hosts_total,
+                )
+            )
+            row.append(self._prepare_number(rpool.cpu_cores))
+            row.append(self._prepare_number(rpool.cpu_threads))
+            row.append(self._prepare_number(rpool.mem_mb_total))
+            row.append(
+                self._prepare_number(rpool.mem_mb_effective, compare_val=rpool.mem_mb_total)
+            )
+
+            table.add_row(*row)
+
+        self.rich_console.print(table)
+
+        if not self.quiet:
+            print()
+
+    # -------------------------------------------------------------------------
+    def _get_totals(self, rpools):
+
+        totals = {
+            "hosts_total": 0,
+            "hosts_avail": 0,
+            "cpu_cores": 0,
+            "cpu_threads": 0,
+            "mem_total": 0,
+            "mem_avail": 0,
+        }
+
+        for rpool in rpools:
+            totals["hosts_total"] += rpool.hosts_total
+            totals["hosts_avail"] += rpool.hosts_effective
+            totals["cpu_cores"] += rpool.cpu_cores
+            totals["cpu_threads"] += rpool.cpu_threads
+            totals["mem_total"] += rpool.mem_mb_total
+            totals["mem_avail"] += rpool.mem_mb_effective
+
+        return totals
+
+    # -------------------------------------------------------------------------
+    def _prepare_number(self, value, may_zero=False, warn_on_value1=False, compare_val=None):
+
+        if value is None:
+            return ""
+
+        try:
+            int_val = int(value)
+        except ValueError:
+            return value
+
+        val_str = format_decimal(int_val, format="#,##0")
+        if not may_zero and int_val == 0:
+            val_str = Text(val_str, style="bold red")
+        elif warn_on_value1 and int_val == 1:
+            val_str = Text(val_str, style="bold yellow")
+        elif compare_val is not None and int_val < compare_val:
+            val_str = Text(val_str, style="bold yellow")
+
+        return val_str
+
+
+# =============================================================================
+def main():
+    """Entrypoint for get-vsphere-cluster-list."""
+    my_path = pathlib.Path(__file__)
+    appname = my_path.name
+
+    locale.setlocale(locale.LC_ALL, "")
+
+    app = GetResPoolListApplication(appname=appname)
+    app.initialized = True
+
+    if app.verbose > 2:
+        print(_("{c}-Object:\n{a}").format(c=app.__class__.__name__, a=app), file=sys.stderr)
+
+    try:
+        app()
+    except KeyboardInterrupt:
+        print("\n" + app.colored(_("User interrupt."), "YELLOW"))
+        sys.exit(5)
+
+    sys.exit(0)
+
+
+# =============================================================================
+if __name__ == "__main__":
+
+    pass
+
+# =============================================================================
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 list

fb_vmware/app/get_storage_cluster_info.py

@@ -0,0 +1,303 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+@summary: Print all available information about a given storaage cluster.
+
+@author: Frank Brehm
+@contact: frank@brehm-online.com
+@copyright: © 2025 by Frank Brehm, Berlin
+"""
+from __future__ import absolute_import, print_function
+
+# Standard modules
+import locale
+import logging
+import pathlib
+import sys
+
+# Third party modules
+from babel.numbers import format_decimal
+
+from fb_tools.common import pp
+from fb_tools.spinner import Spinner
+from fb_tools.xlate import format_list
+
+from rich.table import Table
+
+# Own modules
+from . import BaseVmwareApplication
+from . import VmwareAppError
+from .. import __version__ as GLOBAL_VERSION
+from ..errors import VSphereExpectedError
+from ..xlate import XLATOR
+
+__version__ = "1.0.2"
+LOG = logging.getLogger(__name__)
+
+_ = XLATOR.gettext
+ngettext = XLATOR.ngettext
+
+
+# =============================================================================
+class GetStorageClusterInfoAppError(VmwareAppError):
+    """Base exception class for all exceptions in this application."""
+
+    pass
+
+
+# =============================================================================
+class GetStorageClusterInfoApp(BaseVmwareApplication):
+    """Class for the application objects."""
+
+    show_simulate_option = False
+
+    # -------------------------------------------------------------------------
+    def __init__(
+        self,
+        appname=None,
+        verbose=0,
+        version=GLOBAL_VERSION,
+        base_dir=None,
+        initialized=False,
+        usage=None,
+        description=None,
+        argparse_epilog=None,
+        argparse_prefix_chars="-",
+        env_prefix=None,
+    ):
+        """Initialize the GetStorageClusterInfoApp object."""
+        desc = _(
+            "Tries to get information about the given datastore cluster in "
+            "VMware vSphere and print it out."
+        )
+
+        self.ds_cluster_names = []
+
+        super(GetStorageClusterInfoApp, self).__init__(
+            appname=appname,
+            verbose=verbose,
+            version=version,
+            base_dir=base_dir,
+            description=desc,
+            initialized=False,
+        )
+
+        self.initialized = True
+
+    # -------------------------------------------------------------------------
+    def init_arg_parser(self):
+        """Initiate the argument parser."""
+        self.arg_parser.add_argument(
+            "clusters",
+            metavar="CLUSTER",
+            type=str,
+            nargs="+",
+            help=_("Names of the datastore clusters to get information."),
+        )
+
+        super(GetStorageClusterInfoApp, self).init_arg_parser()
+
+    # -------------------------------------------------------------------------
+    def perform_arg_parser(self):
+        """Evaluate the command line parameters. Maybe overridden."""
+        super(GetStorageClusterInfoApp, self).perform_arg_parser()
+
+        for cluster in self.args.clusters:
+            self.ds_cluster_names.append(cluster)
+
+    # -------------------------------------------------------------------------
+    def _run(self):
+
+        LOG.debug(_("Starting {a!r}, version {v!r} ...").format(a=self.appname, v=self.version))
+
+        ret = 99
+        try:
+            ret = self.show_ds_clusters()
+        finally:
+            self.cleaning_up()
+
+        self.exit(ret)
+
+    # -------------------------------------------------------------------------
+    def show_ds_clusters(self):
+        """Show all datastore clusters."""
+        ret = 0
+
+        try:
+            for vsphere_name in self.vsphere:
+                vsphere = self.vsphere[vsphere_name]
+                vsphere.get_datacenters()
+
+        except VSphereExpectedError as e:
+            LOG.error(str(e))
+            self.exit(8)
+
+        for cluster_name in sorted(self.ds_cluster_names, key=str.lower):
+            if not self.show_ds_cluster(cluster_name):
+                ret = 1
+
+        return ret
+
+    # -------------------------------------------------------------------------
+    def show_ds_cluster(self, cluster_name):
+        """Show a particular datastorecluster on STDOUT."""
+        print()
+        msg_tpl = _("Getting data of datastora cluster {} ... ")
+        if self.verbose:
+            msg = msg_tpl.format(self.colored(cluster_name, "CYAN"))
+            print(msg)
+            ds_cluster = self._get_ds_cluster_obj(cluster_name)
+        else:
+            msg_len = len(msg_tpl.format(cluster_name))
+            spin_prompt = msg_tpl.format(self.colored(cluster_name, "CYAN"))
+            spinner_name = self.get_random_spinner_name()
+            with Spinner(spin_prompt, spinner_name):
+                ds_cluster = self._get_ds_cluster_obj(cluster_name)
+            sys.stdout.write(" " * msg_len)
+            sys.stdout.write("\r")
+            sys.stdout.flush()
+
+        print("{}: ".format(cluster_name), end="")
+        if not ds_cluster:
+            print(self.colored(_("NOT FOUND"), "RED"))
+            return False
+
+        print("{ok}".format(ok=self.colored("OK", "GREEN")))
+        print()
+
+        dsc_table = Table(title=ds_cluster.name, title_style="bold cyan", box=None)
+        dsc_table.add_column(highlight=True, style="bold", no_wrap=True)
+        dsc_table.add_column()
+
+        info_table = Table(box=None, show_header=False, show_footer=False)
+        info_table.add_column(highlight=True, no_wrap=True)
+        info_table.add_column()
+        info_table.add_row("vSphere:", ds_cluster.vsphere)
+        info_table.add_row("Datacenter:", ds_cluster.dc_name)
+        info_table.add_row(
+            _("Connected computing clusters") + ":",
+            format_list(sorted(ds_cluster.compute_clusters)),
+        )
+
+        dsc_table.add_row(_("General"), info_table)
+        dsc_table.add_row("", "")
+
+        usage_pc_out = "- %"
+        used = ds_cluster.capacity_gb - ds_cluster.free_space_gb
+        if ds_cluster.capacity_gb:
+            used_pc = used / ds_cluster.capacity_gb
+            usage_pc_out = format_decimal(used_pc, format="0.0 %")
+
+        cap_table = Table(box=None, show_footer=True)
+        cap_table.add_column(header=_("Datastore"), footer=_("Datastore cluster total"))
+        cap_table.add_column(
+            header=_("Capacity in GB"),
+            footer=format_decimal(ds_cluster.capacity_gb, format="#,##0"),
+            justify="right",
+        )
+        cap_table.add_column(
+            header=_("Calculated usage in GB"),
+            footer=format_decimal(used, format="#,##0"),
+            justify="right",
+        )
+        cap_table.add_column(header=_("Usage in percent"), footer=usage_pc_out, justify="right")
+        cap_table.add_column(
+            header=_("Free space in GB"),
+            footer=format_decimal(ds_cluster.free_space_gb, format="#,##0"),
+            justify="right",
+        )
+        for ds_name in sorted(ds_cluster.datastores.keys(), key=str.lower):
+            ds = ds_cluster.datastores[ds_name]
+            ds_used = ds.capacity_gb - ds.free_space_gb
+            ds_used_pc = "- %"
+            if ds.capacity_gb:
+                ds_used_pc = format_decimal((ds_used / ds.capacity_gb), format="0.0 %")
+            cap_table.add_row(
+                ds_name,
+                format_decimal(ds.capacity_gb, format="#,##0"),
+                format_decimal(ds_used, format="#,##0"),
+                ds_used_pc,
+                format_decimal(ds.free_space_gb, format="#,##0"),
+            )
+
+        dsc_table.add_row(_("Capacity"), cap_table)
+        dsc_table.add_row("", "")
+
+        hosts_table = Table(box=None, show_header=False, show_footer=False)
+        hosts_table.add_column()
+        for host in sorted(ds_cluster.hosts, key=str.lower):
+            hosts_table.add_row("* " + host)
+
+        dsc_table.add_row(_("Connected hosts"), hosts_table)
+        dsc_table.add_row("", "")
+
+        self.rich_console.print(dsc_table)
+
+    # -------------------------------------------------------------------------
+    def _get_ds_cluster_obj(self, cluster_name):
+
+        if self.verbose > 1:
+            LOG.debug(
+                _("Pulling full data of datastore cluster {} ...").format(
+                    self.colored(cluster_name, "CYAN")
+                )
+            )
+
+        ds_cluster = None
+
+        for vsphere_name in self.vsphere:
+            vsphere = self.vsphere[vsphere_name]
+            LOG.debug(
+                _("Searching for datastore cluster {dsc} in vSphere {vs} ...").format(
+                    dsc=self.colored(cluster_name, "CYAN"), vs=self.colored(vsphere_name, "CYAN")
+                )
+            )
+
+            ds_cluster = vsphere.get_ds_cluster(
+                cluster_name, vsphere_name=vsphere_name, no_error=True, detailled=True
+            )
+            if not ds_cluster:
+                continue
+
+            break
+
+        if self.verbose > 2:
+            LOG.debug(
+                "Got data of datastore cluster {}:\n".format(cluster_name)
+                + pp(ds_cluster.as_dict())
+            )
+
+        return ds_cluster
+
+
+# =============================================================================
+def main():
+    """Entrypoint for get-vsphere-vm-info."""
+    my_path = pathlib.Path(__file__)
+    appname = my_path.name
+
+    locale.setlocale(locale.LC_ALL, "")
+
+    app = GetStorageClusterInfoApp(appname=appname)
+    app.initialized = True
+
+    if app.verbose > 2:
+        print(_("{c}-Object:\n{a}").format(c=app.__class__.__name__, a=app), file=sys.stderr)
+
+    try:
+        app()
+    except KeyboardInterrupt:
+        print("\n" + app.colored(_("User interrupt."), "YELLOW"))
+        sys.exit(5)
+
+    sys.exit(0)
+
+
+# =============================================================================
+if __name__ == "__main__":
+
+    pass
+
+# =============================================================================
+
+# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 list