.. meta::
   :description: How to manage DNS and DHCP servers in Micetro
   :keywords: DNS servers, DHCP servers, DNS server management, DHCP server management

.. _webapp-server-management:

Service Management
===================
Service Management is the place for connecting and orchestrating DNS, DHCP, and IP Address Management (IPAM) services with Micetro. Your services can be hosted on-premises, deployed on specialized appliances, or reside in the cloud. Connected services are displayed on the :guilabel:`Service Management` tab on the :guilabel:`Admin` page.

**To access Service Management**:

1. Select :guilabel:`Admin` on the top navigation bar.

2. Click the :guilabel:`Service Management` tab in the upper-left corner.

   .. image:: ../../images/dns-context-10.6.png      
       :width: 85%
   |
   * By default, all services configured in the system are shown.

   * In the left pane, you can filter the list by type of service or provider.
   
   * In the right pane, the properties of a selected service are shown.

.. note:: 
   The Micetro web interface does not yet provide full management of IPAM services. Therefore they are not listed here, but you can still enable IPAM services by using the :guilabel:`Add Service` function. 

User Permissions and Access Management
---------------------------------------
Depending on user permissions and available license keys, DNS and DHCP services and functions can be disabled or hidden.

Micetro has a granular role-based :ref:`access-control` system. For DNS and DHCP administrators, it is recommended to be members of the built-in **DNS Administrators** and/or **IPAM Administrators** roles. To manage Appliances, it is recommended to be a member of the built-in **Administrators** role. 

When not using the built-in roles, users need to be members of a role with the following permissions. Note that additional permissions might be necessary for comprehensive service management. For more information on Micetro's granular role-based access controls, see :ref:`access-control`. 

* To manage DNS services: **Administer DNS servers**

* To manage DHCP services: **Administer DHCP servers**

* To manage cloud services: **Access to manage clouds**

* To manage appliance services: **Administer appliances**

Supported Platforms
-------------------
Micetro supports the following DNS and DHCP platforms:

* DNS

  * AuthServe

  * AWS Route 53 (cloud)

  * Azure DNS (cloud)

  * BIND

  * DynDNS (cloud), (Note DynDNS is EOL May 31st 2023)

  * Edge DNS (cloud)

  * Microsoft DNS

  * NS1 (cloud)

  * Unbound (deprecated, new services cannot be added)

  * Micetro DDS Appliance


* DHCP

  * Cisco IOS

  * Cisco Meraki

  * ISC DHCP

  * Kea

  * Microsoft DHCP

  * Micetro DDS Appliance
  
Micetro Agents
--------------
Micetro requires an agent to handle communication with external services. The installation location of the agent depends on the service type and whether it operates on-premises or in the cloud. Agents are installed on the respective machine, the machine running Micetro Central, or on any machine with the same domain as the DNS/DHCP servers. A single agent can manage communication with multiple servers. For more information on agents and how to install them, see :ref:`install-controllers`.

.. note::
   When managing Microsoft DNS servers on remote computers using the DNS agent, some actions for static zones may not be available:

   * Disabling resource record

   * Enabling resource record
   
   * Viewing and editing record comments

   * Disabling zone

   To perform these actions, you need to install the DNS agent on the server and use that connection when adding the server.
   
.. _adding-service:

Adding a Service
----------------
You must have permission to administer DNS to add a new service to Micetro.

Adding a new service is either a two or three-step process, depending on the type of service being added.

**To add a service**:

1. On the :guilabel:`Service Management` tab, click :guilabel:`Add Service`.   

2. Select the platform you wish to use. The list of options is based on your license keys. You can use the **DNS**, **DHCP**, and **IPAM** filters at the top to narrow down the list. You can also use the search box to find the specific service you need.

  .. image:: ../../images/add-servive-dialog.png
      :width: 65%

3. Select an agent: 

   .. image:: ../../images/add-kea.png
     :width: 65%

   * This step is not required for cloud services.

   * For ISC BIND and ISC DHCP this step is not required because the agent must be installed on the service host itself.

   * With the exception of the above services, the agent can be installed on the Micetro Central host, the service host, or for MS DNS/DHCP, ISC Kea, Cisco Meraki, and Cisco IOS, on a different host. If you have already added a service of this type, you can select from existing agents or create a new one. A single agent can be used to manage multiple servoce connections.

   * In the case of **AuthServe**, you can select from a list of available agents that were registered in the installation process. You can also register a new agent on the :guilabel:`New Agent` tab. Enter a hostname for the agent and, optionally, the IP address. If the hostname is not resolvable, an IP address is needed here.
   
    .. image:: ../../images/add-authserve.png
         :width: 65%

4. Enter the necessary details:
  * **Cloud services**: Each service type has its set of credentials in addition to the optional service name. For more details on adding cloud services, see :ref:`cloud`.

  * **On-premises services**:

    * Enter the hostname or IP address of the service/server.

    * **AuthServe** uses a channel as the connection string. The channel name is mapped to a host name in a server configuration file. 'ansp' is the default channel name, which maps to localhost. To use a different host name, the format is ``"1.2.3.4#<someseceret>"``. Consult the AuthServe documentation for details.

Editing Services
-----------------
Depending on the service, you can change the name and/or custom properties for the service. For example, if you need to refer to the service by another name or if you are connecting to the service by an IP Address and the IP Address has changed. 

**To edit a service**:

1. Locate the service you want to edit. 

2. Select :guilabel:`Edit service` on either the :guilabel:`Action` or the Row :guilabel:`...` menu. You can also double-click the service.

3. Make the necessary changes. Click :guilabel:`Save` to save the changes.

Other Service Actions
----------------------
All actions applicable to a selected server can be accessed either on the :guilabel:`Actions` menu above the list, or the Row :guilabel:`...` menu that appears on the right-hand side when you hover over a row.

.. csv-table::
  :header: "Action", "Description"
  :widths: 15, 85

  "Attach service", "Attaches a previously detached server/service." 
  "Detach service", "Detaches or disables the server/service. When a server is detached, it is not synchronized with Micetro and is excluded from various checks. When a server is detached, it appears dimmed in the Service overview. The server can be reattached to become part of the server synchronization again."
  "Synchronize", "Initiates the synchronization of zones and records, or scopes."
  "Remove service", "Removes the selected server/service from Micetro. This option is available only for the Administrator account."
  "Access", "Shows which roles have access to the service and what actions they are authorized to perform. For more information about how to manage object access, see :ref:`acl-object-access`."
  "View history", "Allows you to view the history for the selected server/service."

Service States
--------------
The Service overview shows indicators representing the status of the each service configured in the system.
    
These indicators may refer to the :ref:`install-controllers` running on the DNS/DHCP server, or the DNS/DHCP service itself. 

See the following table for detailed information about these indicators:

.. csv-table::
    :header: "Indicator", "Component", "Explanation"
    :widths: 10, 10, 80

    "Unknown", "Agent", "The status of the DNS/DHCP agent is unknown."
    "OK", "Server, Agent", "The DNS/DHCP agent and service are both OK."
    "Unreachable", "Agent", "The DNS/DHCP agent is offline or otherwise unreachable."
    "Out of date", "Agent", "The DNS/DHCP agent has a different version than Central."
    "Updating", "Agent", "The DNS/DHCP agent is being updated."
    "Uninitialized", "Server", "The DNS/DHCP server is uninitialized and needs to be manually initialized."
    "Detached", "Server", "The DNS/DHCP server has been detached without removing it from Micetro."
    "Service Down", "Server", "The DNS/DHCP server is down and not responding to queries."
    "Service Impaired", "Server", "The DNS/DHCP server is running but impaired. [1]_ "
    "Service Shut Down", "Server", "The DNS/DHCP server has been shut down manually through Micetro."

.. [1] In Kea HA configurations. See :ref:`dhcp-kea-ha`.

DNS Services
------------
See the following topic for information about configuring the BIND DNS platform:

.. toctree::
  :maxdepth: 1

  admin_dns_bind

DHCP Services
--------------
For detailed information about the different DHCP platforms and their configurations, refer to:

.. toctree::
  :maxdepth: 1

  admin_dhcp_windows
  admin_dhcp_kea
  admin_dhcp_isc
  admin_dhcp_cisco
  admin_dhcp_meraki