mreg-cli 1.0.0__py3-none-any.whl

mreg_cli/commands/host_submodules/a_aaaa.py

@@ -0,0 +1,452 @@
+"""A/AAAA-related subcommands for the host command.
+
+Commands implemented:
+    - a_add
+    - a_change
+    - a_move
+    - a_remove
+    - a_show
+    - aaaa_add
+    - aaaa_change
+    - aaaa_move
+    - aaaa_remove
+    - aaaa_show
+"""
+
+from __future__ import annotations
+
+import argparse
+
+from mreg_cli.api.models import Host, HostList, IPAddress, MACAddressField, Network, NetworkOrIP
+from mreg_cli.commands.host import registry as command_registry
+from mreg_cli.exceptions import (
+    DeleteError,
+    EntityAlreadyExists,
+    EntityNotFound,
+    ForceMissing,
+    InputFailure,
+)
+from mreg_cli.outputmanager import OutputManager
+from mreg_cli.types import Flag, IP_AddressT, IP_Version
+
+
+def _bail_if_ip_in_use_and_not_force(ip: IP_AddressT) -> None:
+    """Check if an IP is in use and bail if it is.
+
+    :param ip: The IP address to check.
+    """
+    hosts_using_ip = HostList.get_by_ip(ip)
+    if hosts_using_ip:
+        hostnames = ", ".join(hosts_using_ip.hostnames())
+        raise ForceMissing(f"IP {ip} in use by {hostnames}, must force.")
+
+
+def _ip_change(args: argparse.Namespace, ipversion: IP_Version) -> None:
+    """Change A record. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, old, new, force)
+    """
+    if args.old == args.new:
+        raise EntityAlreadyExists("New and old IP are equal")
+
+    old_ip = NetworkOrIP(ip_or_network=args.old).as_ip()
+
+    new_ip = NetworkOrIP(ip_or_network=args.new)
+    if new_ip.is_network():
+        network = Network.get_by_network_or_raise(str(new_ip.ip_or_network))
+        new_ip = network.get_first_available_ip()
+    else:
+        new_ip = new_ip.as_ip()
+
+    if old_ip.version != ipversion:
+        raise InputFailure("Old IP version does not match the requested version")
+
+    if new_ip.version != ipversion:
+        raise InputFailure("New IP version does not match the requested version")
+
+    host = Host.get_by_any_means_or_raise(args.name)
+
+    host_ip = host.get_ip(old_ip)
+    if not host_ip:
+        raise EntityNotFound(f"Host {host} does not have IP {old_ip}")
+
+    ip_obj = IPAddress.get(host_ip.id)
+    if not ip_obj:
+        raise EntityNotFound(f"IP {old_ip} not found")
+
+    if not args.force:
+        _bail_if_ip_in_use_and_not_force(new_ip)
+
+    ip_obj.patch(fields={"ipaddress": str(new_ip)})
+
+    OutputManager().add_ok(f"changed ip {args.old} to {new_ip} for {host}")
+
+
+def _ip_move(args: argparse.Namespace, ipversion: IP_Version) -> None:
+    """Move an IP from a host to another host. Will move also move the PTR, if any.
+
+    :param args: argparse.Namespace (ip, fromhost, tohost)
+    :param ipversion: 4 or 6
+    """
+    ip = NetworkOrIP(ip_or_network=args.ip)
+    if ip.is_network():
+        raise InputFailure("IP cannot be a network")
+    if ip.as_ip().version != ipversion:
+        raise InputFailure(
+            f"IP version {ip.as_ip().version} does not match the requested version {ipversion}"
+        )
+
+    from_host = Host.get_by_any_means_or_raise(args.fromhost)
+    to_host = Host.get_by_any_means_or_raise(args.tohost)
+
+    host_ip = from_host.get_ip(ip.as_ip())
+
+    ptr = from_host.get_ptr_override(ip.as_ip())
+    if not host_ip and not ptr:
+        raise EntityNotFound(f"Host {from_host} has no IP or PTR with address {ip}")
+
+    msg = ""
+    if host_ip:
+        host_ip.patch(fields={"host": to_host.id})
+        msg = f"Moved ipaddress {args.ip}"
+    else:
+        msg += "No ipaddresses matched. "
+
+    if ptr:
+        ptr.patch(fields={"host": to_host.id})
+        msg += "Moved PTR override."
+
+    OutputManager().add_line(msg)
+
+
+def _ip_remove(args: argparse.Namespace, ipversion: IP_Version) -> None:
+    """Remove A record from host. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, ip)
+    """
+    host = Host.get_by_any_means_or_raise(args.name)
+    ip = NetworkOrIP(ip_or_network=args.ip)
+    if ip.is_network():
+        raise InputFailure("IP cannot be a network")
+    if ip.as_ip().version != ipversion:
+        raise InputFailure(
+            f"IP version {ip.as_ip().version} does not match the requested version {ipversion}"
+        )
+
+    host_ip = host.get_ip(ip.as_ip())
+    if not host_ip:
+        raise EntityNotFound(f"Host {host} does not have IP {ip}")
+
+    if host_ip.delete():
+        OutputManager().add_ok(f"Removed ipaddress {args.ip} from {host}")
+    else:
+        raise DeleteError(f"Failed to remove ipaddress {args.ip} from {host}")
+
+
+def _add_ip(
+    args: argparse.Namespace,
+    ipversion: IP_Version = 4,
+) -> Host:
+    """Add a new IP address to a host.
+
+    :param host: Name of the host to add the IP to.
+    :param ip: The IP address to add.
+    :param macaddress: The MAC address to add.
+    :param force: Whether to force the addition.
+
+    :return: The updated host object.
+    """
+    host = Host.get_by_any_means_or_raise(args.name)
+    ip_or_net = NetworkOrIP(ip_or_network=args.ip)
+
+    if ipversion == 4 and (ip_or_net.is_ipv6() or ip_or_net.is_ipv6_network()):
+        raise InputFailure("Use aaaa_add for IPv6 addresses")
+    elif ipversion == 6 and (ip_or_net.is_ipv4() or ip_or_net.is_ipv4_network()):
+        raise InputFailure("Use a_add for IPv4 addresses")
+
+    ipaddr = None
+    network = None
+    if ip_or_net.is_network():
+        network = Network.get_by_network_or_raise(str(ip_or_net.ip_or_network))
+        ip = network.get_first_available_ip()
+        ipaddr = ip
+    else:
+        network = Network.get_by_ip(ip_or_net.as_ip())
+        ip = ip_or_net
+        ipaddr = ip.as_ip()
+
+    if not args.force and network and network.frozen:
+        raise ForceMissing(f"Network {network.network} is frozen, must force")
+
+    if not args.force and host.has_ip(ipaddr):
+        raise EntityAlreadyExists(f"Host {host} already has IP {ipaddr}")
+
+    if not args.force and len(host.ipaddresses) > 0:
+        raise ForceMissing(f"Host {host} already has one or more ip addresses, must force")
+
+    mac = None
+    if args.macaddress:
+        try:
+            mac = MACAddressField(address=args.macaddress)
+        except ValueError as e:
+            raise InputFailure(f"Invalid MAC address: {mac}") from e
+
+    if not args.force:
+        _bail_if_ip_in_use_and_not_force(ipaddr)
+
+    host = host.add_ip(ipaddr, mac)  # returns the refetched host
+    OutputManager().add_ok(f"Added ipaddress {ipaddr} to {host}")
+    return host
+
+
+@command_registry.register_command(
+    prog="a_add",
+    description="Add an A record to host. If NAME is an alias the cname host is used.",
+    short_desc="Add A record.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+        Flag(
+            "ip",
+            description=(
+                "The IP of new A record. May also be a network, "
+                "in which case a random IP address from that network "
+                "is chosen."
+            ),
+            metavar="IP/network",
+        ),
+        Flag("-macaddress", description="Mac address", metavar="MACADDRESS"),
+        Flag("-force", action="store_true", description="Enable force."),
+    ],
+)
+def a_add(args: argparse.Namespace) -> None:
+    """Add an A record to host. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, ip, force, macaddress)
+    """
+    _add_ip(args, 4)
+
+
+@command_registry.register_command(
+    prog="a_change",
+    description=(
+        "Change an A record for the target host. If NAME is an alias the cname host is used."
+    ),
+    short_desc="Change A record.",
+    flags=[
+        Flag(
+            "name",
+            description="Name of the target host.",
+            short_desc="Host name.",
+            metavar="NAME",
+        ),
+        Flag(
+            "-old",
+            description="The existing IP that should be changed.",
+            short_desc="IP to change.",
+            required=True,
+            metavar="IP",
+        ),
+        Flag(
+            "-new",
+            description=(
+                "The new IP address. May also be a network, in which "
+                "case a random IP from that network is chosen."
+            ),
+            short_desc="New IP.",
+            required=True,
+            metavar="IP/network",
+        ),
+        Flag("-force", action="store_true", description="Enable force."),
+    ],
+)
+def a_change(args: argparse.Namespace) -> None:
+    """Change A record. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, old, new, force)
+    """
+    _ip_change(args, 4)
+
+
+@command_registry.register_command(
+    prog="a_move",
+    description="Move A record from a host to another host",
+    short_desc="Move A record",
+    flags=[
+        Flag("-ip", description="IP to move", required=True, metavar="IP"),
+        Flag(
+            "-fromhost",
+            description="Name of source host",
+            required=True,
+            metavar="NAME",
+        ),
+        Flag(
+            "-tohost",
+            description="Name of destination host",
+            required=True,
+            metavar="NAME",
+        ),
+    ],
+)
+def a_move(args: argparse.Namespace) -> None:
+    """Move an IP from a host to another host. Will move also move the PTR, if any.
+
+    :param args: argparse.Namespace (ip, fromhost, tohost)
+    """
+    _ip_move(args, 4)
+
+
+@command_registry.register_command(
+    prog="a_remove",
+    description="Remove an A record from the target host.",
+    short_desc="Remove A record.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+        Flag("ip", description="IP to remove.", metavar="IP"),
+    ],
+)
+def a_remove(args: argparse.Namespace) -> None:
+    """Remove A record from host. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, ip)
+    """
+    _ip_remove(args, 4)
+
+
+@command_registry.register_command(
+    prog="a_show",
+    description="Show hosts ipaddresses. If NAME is an alias the cname host is used.",
+    short_desc="Show ipaddresses.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+    ],
+)
+def a_show(args: argparse.Namespace) -> None:
+    """Show hosts ipaddresses. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name)
+    """
+    Host.get_by_any_means_or_raise(args.name).output_ipaddresses(only=4)
+
+
+@command_registry.register_command(
+    prog="aaaa_add",
+    description="Add an AAAA record to host. If NAME is an alias the cname host is used.",
+    short_desc="Add AAAA record.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+        Flag(
+            "ip",
+            description="The IPv6 to add to the target host.",
+            metavar="IPv6",
+        ),
+        Flag("-macaddress", description="Mac address", metavar="MACADDRESS"),
+        Flag("-force", action="store_true", description="Enable force."),
+    ],
+)
+def aaaa_add(args: argparse.Namespace) -> None:
+    """Add an AAAA record to host. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, ip, force, macaddress)
+    """
+    _add_ip(args, 6)
+
+
+@command_registry.register_command(
+    prog="aaaa_change",
+    description="Change AAAA record. If NAME is an alias the cname host is used.",
+    short_desc="Change AAAA record.",
+    flags=[
+        Flag(
+            "name",
+            description="Name of the target host.",
+            short_desc="Host name.",
+            metavar="NAME",
+        ),
+        Flag(
+            "-old",
+            description="The existing IPv6 that should be changed.",
+            short_desc="IPv6 to change.",
+            required=True,
+            metavar="IPv6",
+        ),
+        Flag(
+            "-new",
+            description="The new IPv6 address.",
+            short_desc="New IPv6.",
+            required=True,
+            metavar="IPv6",
+        ),
+        Flag("-force", action="store_true", description="Enable force."),
+    ],
+)
+def aaaa_change(args: argparse.Namespace) -> None:
+    """Change AAAA record. If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, old, new, force)
+    """
+    _ip_change(args, 6)
+
+
+@command_registry.register_command(
+    prog="aaaa_move",
+    description="Move AAAA record from a host to another host",
+    short_desc="Move AAAA record",
+    flags=[
+        Flag("-ip", description="IP to move", required=True, metavar="IP"),
+        Flag(
+            "-fromhost",
+            description="Name of source host",
+            required=True,
+            metavar="NAME",
+        ),
+        Flag(
+            "-tohost",
+            description="Name of destination host",
+            required=True,
+            metavar="NAME",
+        ),
+    ],
+)
+def aaaa_move(args: argparse.Namespace) -> None:
+    """Move an IP from a host to another host. Will move also move the PTR, if any.
+
+    :param args: argparse.Namespace (ip, fromhost, tohost)
+    """
+    _ip_move(args, 6)
+
+
+@command_registry.register_command(
+    prog="aaaa_remove",
+    description="Remove AAAA record from host. If NAME is an alias the cname host is used.",
+    short_desc="Remove AAAA record.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+        Flag("ip", description="IPv6 to remove.", metavar="IPv6"),
+    ],
+)
+def aaaa_remove(args: argparse.Namespace) -> None:
+    """Remove AAAA record from host.
+
+    If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name, ip)
+    """
+    _ip_remove(args, 6)
+
+
+@command_registry.register_command(
+    prog="aaaa_show",
+    description="Show hosts AAAA records. If NAME is an alias the cname host is used.",
+    short_desc="Show AAAA records.",
+    flags=[
+        Flag("name", description="Name of the target host.", metavar="NAME"),
+    ],
+)
+def aaaa_show(args: argparse.Namespace) -> None:
+    """Show hosts ipaddresses.
+
+    If <name> is an alias the cname host is used.
+
+    :param args: argparse.Namespace (name)
+    """
+    Host.get_by_any_means_or_raise(args.name).output_ipaddresses(only=6)

mreg_cli/commands/host_submodules/bacnet.py

@@ -0,0 +1,126 @@
+"""Backnet subcommands for the host command.
+
+Commands implemented:
+
+    - bacnetid_add
+    - bacnetid_remove
+    - bacnetid_list
+"""
+
+from __future__ import annotations
+
+import argparse
+
+from mreg_cli.api.models import BacnetID, Host
+from mreg_cli.commands.host import registry as command_registry
+from mreg_cli.exceptions import (
+    CreateError,
+    DeleteError,
+    EntityAlreadyExists,
+    EntityNotFound,
+    EntityOwnershipMismatch,
+    InputFailure,
+)
+from mreg_cli.outputmanager import OutputManager
+from mreg_cli.types import Flag
+
+
+@command_registry.register_command(
+    prog="bacnetid_add",
+    description="Assign a BACnet ID to the host.",
+    short_desc="Add BACnet ID",
+    flags=[
+        Flag("name", description="Name of host.", metavar="NAME"),
+        Flag("-id", description=f"ID value (0-{BacnetID.MAX_ID()})", metavar="ID"),
+    ],
+)
+def bacnetid_add(args: argparse.Namespace) -> None:
+    """Assign a BACnet ID to the host.
+
+    :param args: argparse.Namespace (name, id)
+    """
+    host = Host.get_by_any_means_or_raise(args.name)
+    host_bacnet = host.bacnet()
+    if host_bacnet is not None:
+        raise EntityAlreadyExists(f"{host.name} already has BACnet ID {host_bacnet.id}.")
+
+    existing = BacnetID.get(args.id)
+    if existing:
+        raise EntityOwnershipMismatch(
+            f"BACnet ID {existing.id} is already in use by {existing.hostname}."
+        )
+
+    BacnetID.create(params={"hostname": host.name.hostname, "id": args.id})
+
+    validator = BacnetID.get(args.id)
+    if validator and validator.hostname == host.name.hostname:
+        OutputManager().add_ok(f"Assigned BACnet ID {validator.id} to {validator.hostname}.")
+    else:
+        raise CreateError(f"Failed to assign BACnet ID {args.id} to {host.name.hostname}.")
+
+
+@command_registry.register_command(
+    prog="bacnetid_remove",
+    description="Unassign the BACnet ID from the host.",
+    short_desc="Remove BACnet ID",
+    flags=[
+        Flag("name", description="Name of host.", metavar="NAME"),
+    ],
+)
+def bacnetid_remove(args: argparse.Namespace) -> None:
+    """Unassign the BACnet ID from the host.
+
+    :param args: argparse.Namespace (name)
+    """
+    host = Host.get_by_any_means_or_raise(args.name)
+    host_bacnet = host.bacnet()
+    if host_bacnet is None:
+        raise EntityNotFound(f"{host.name} does not have a BACnet ID assigned.")
+
+    if host_bacnet.delete():
+        OutputManager().add_ok(f"Unassigned BACnet ID {host_bacnet.id} from {host.name}.")
+    else:
+        raise DeleteError(f"Failed to unassign BACnet ID {host_bacnet.id} from {host.name}.")
+
+
+@command_registry.register_command(
+    prog="bacnetid_list",
+    description="Find/list BACnet IDs and hostnames by ID.",
+    short_desc="List used BACnet IDs",
+    flags=[
+        Flag(
+            "-min",
+            description=f"Minimum ID value (0-{BacnetID.MAX_ID()})",
+            flag_type=int,
+            metavar="MIN",
+        ),
+        Flag(
+            "-max",
+            description=f"Maximum ID value (0-{BacnetID.MAX_ID()})",
+            flag_type=int,
+            metavar="MAX",
+        ),
+    ],
+)
+def bacnetid_list(args: argparse.Namespace) -> None:
+    """Find/list BACnet IDs and hostnames by ID.
+
+    :param args: argparse.Namespace (min, max)
+    """
+    min_id = args.min if args.min is not None else 0
+    max_id = args.max if args.max is not None else BacnetID.MAX_ID()
+
+    if min_id < 0:
+        raise InputFailure("Minimum ID value cannot be less than 0.")
+
+    if min_id is not None and max_id is not None and min_id > max_id:
+        raise InputFailure("Minimum ID value cannot be greater than maximum ID value.")
+
+    if max_id is not None and max_id > BacnetID.MAX_ID():
+        raise InputFailure(f"The maximum ID value is {BacnetID.MAX_ID()}.")
+
+    bacnetids = BacnetID.get_in_range(min_id, max_id)
+    if not bacnetids:
+        raise EntityNotFound("No BACnet IDs found in the specified range.")
+
+    BacnetID.output_multiple(bacnetids)