# Chapter 13: Admin

# List of XMPP relays

The**XMPP relay** are communication points between the different machines in your network.

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/brEimage.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/brEimage.png)

##### Why is it useful:

This allows you to see all active connections and understand how machines communicate with each other.

##### Steps:

1. In the menu, click **List of Relays**.
2. A page opens with a relay list.
3. For each relay, you see several informations such as:
    
    
    - The name (called **JID**)
    - The **cluster** to which it belongs
    - The **Description** Cluster
    - The **Number of machines** managed:
        
        
        - Total machinery
        - Number of machines not inventoried online
    - His classes
    - Address **MAC** also called physical address
    - L**IP address** relay
4. A number of quick actions are also available.

##### Tip:

You can **search** a relay by typing a keyword in the search bar at the top of the list.

# Cluster List

One**cluster**, it is a group of relays that are grouped together to organize the network more logically.

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/QEoimage.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/QEoimage.png)

##### Why is it useful:

This helps you better manage your network, especially if you have different environments (e.g. testing, production, etc.).

##### Steps:

1. Go to the section .
2. You will see a list with:
    
    
    - The **name of cluster**
    - Its **Description**
    - The **type** (private or public)
    - The **relay** Associated

##### Example:

A cluster named Public can contain all shared public relays.

By clicking on the pencil in Actions, you can edit the Cluster by following the following steps:

1. Choose a cluster name
2. Select text for description
3. Select external relays to the cluster to put in the cluster and vice versa
4. Validate

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OQ7image-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OQ7image-png.png)

# Create a cluster

Create a**cluster** allows you to better organize your relays according to your needs (e.g. separate tests from production). This is exactly the same form as the editing form.

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OW5image-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OW5image-png.png)

#### Steps:

1. Click **New Cluster** in the menu.
2. Press the button **Add a new cluster**.
3. Fill in the fields:
    
    
    - **Name** of the cluster (e.g. "TestCluster")
    - **Description** (e.g. "Cluster for test relays")
4. Choose the relays you want to associate with (a list displays).
5. Click  to record.

# Managing Rules (Rules)

The**rules** allow you to automate certain actions or behaviors of the network.

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/dQximage-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/dQximage-png.png)

##### Why is it useful:

This can, for example, initiate automatic verification or apply specific parameters under defined conditions.

##### Steps:

1. Click **"Rules"** in the menu.
2. On the page you can:
    
    
    - **Change order of priority** existing rules by pressing the arrow that points down to decrease it or the one that points up to increase it.[![down.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/r7Zdown-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/r7Zdown-png.png)[![up.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/KwOup-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/KwOup-png.png)
    - **Add new rule** according to your needs[![zhCx9ga4nuPgr4B1-addfile.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/eXnzhcx9ga4nupgr4b1-addfile-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/eXnzhcx9ga4nupgr4b1-addfile-png.png)
    - See **detail** a rule
    - [![display.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/W1Ddisplay-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/W1Ddisplay-png.png)

When clicking on the logo plus to add a new rule, you can access the following form:

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/2Zeimage-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/2Zeimage-png.png)

Fill the fields one by one:

1. Choose the rule
2. Choose your relay (Relays)
3. Describe the subject
4. Write the regex to check
5. Validate

Even without being technical, you can ask an administrator what rules are recommended for your environment.

# Quick action

[![image.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/tlGimage-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/tlGimage-png.png)

Each XMPP relay has a set of**rapid action** which allow direct interaction with the machines it manages. These actions are accessible from the **list of relays** and are designed to simplify the day-to-day operations of administration, diagnosis or configuration, without requiring advanced technical knowledge.

Here is a detailed overview of each action, its usefulness and the procedure for using it.

##### **1. See the list of installed packages**

**Objective**  
View software installed on machines attached to a relay.

**Procedure**

**[![pkgs.png](https://wva.siveo.net/uploads/images/gallery/2025-04/scaled-1680-/JgqxjpUmvv55fvBM-pkgs.png)](https://wva.siveo.net/uploads/images/gallery/2025-04/JgqxjpUmvv55fvBM-pkgs.png)**

1. Click on the button **"List of packages"** to the right of the relay concerned.
2. A window opens displaying installed software, with its name and version.

**When to use**

- To verify the presence of a program.
- To control deployed software versions.

##### **2. Reconfigure relay related machines**

**Objective**  
Automatically reapply the active configuration to the machines attached to the relay.

**Procedure**

**[![reconfiguregroup.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/rJgreconfiguregroup-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/rJgreconfiguregroup-png.png)**

1. Click **"Reconfigure"**.
2. Confirm the action if validation is requested.
3. The machines are again given the current configuration.

**When to use**

- After changing the settings, rules or configuration files.
- If a machine appears to be unsynchronised or non-compliant.

##### **3. Change the relay of one or more machines (Switch function)**

**Objective**  
Move one or more machines from one relay to another.

**Procedure**

**[![stop.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/yyUstop-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/yyUstop-png.png)**

1. Click **Switch** to the right of the original relay.
2. Select the moving machines.
3. Choose the destination relay.
4. Validate to apply the change.

**When to use**

- In case of maintenance or removal of a relay.
- During a reorganization of the network architecture.

##### **4. Edit Configuration Files**

**Objective**  
Manually modify the configuration files of a relay or its machines.

**Procedure**

**[![settings.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/s2Fsettings-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/s2Fsettings-png.png)**

1. Click **"Edit configuration files" (first working image)**
2. An editing interface opens.
3. Make the necessary changes.
4. Save the changes.

**When to use**

- To adjust a specific configuration to a specific need.
- During a test or manual procedure.

**Note** This operation acts directly on the system. Use with caution.

##### **5. Show current or past audits (QA)**

**Objective**  
Consult compliance, safety or quality tests performed on machines.

**Procedure**

**[![details.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/poxdetails-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/poxdetails-png.png)**

1. Click **"QA launched"**.
2. A window displays the list of tests performed and their status (successful or failed).

**When to use**

- To check that the rules are being applied.
- To identify possible malfunctions.

##### **6. Access system actions (advanced diagnostic)**

**Objective**  
Use remote diagnostic or intervention tools on a machine.

**Procedure**

**[![quickaction.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/v8qquickaction-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/v8qquickaction-png.png)**

1. Click **Action** Next to the relay.
2. Select one of the available options:
    
    
    - **Reboot** : restarting the machine.
    - **Process** : visualization of processes in progress.
    - **Disk use** : consultation of the disk space used.
    - **Agent version** : version of software agent installed.
    - **Netstat** : display of active network connections.
    - **Console** : opening of a command line interface.

**When to use**

- When a machine is broken, slowed or unstable.
- For quick diagnosis or manual verification.

##### **7. Banning a machine**

**Objective**  
Temporaryly block a machine's access to the system.

**Procedure**

**[![ban.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/ieHban-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/ieHban-png.png)**

1. Click **"Bannir"** Next to the relay.
2. Confirm the banner.
3. The machine is isolated from the rest of the network.

**When to use**

- In case of abnormal behaviour, suspicion of compromise or critical error.

##### **8. Debanniating a machine**

**Objective**  
Lift the block applied to a previously banned machine.

**Procedure**

**[![unban.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/mdLunban-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/mdLunban-png.png)**

1. Click **"Debannier"**.
2. The machine regains its normal communication rights.

**When to use**

- After correcting the initial problem.
- If the machine was incorrectly blocked.

##### **9. Remote control**

**Objective**  
Control a machine remotely as if you were physically in front of it.

**Procedure**

**[![control.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OrRcontrol-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/OrRcontrol-png.png)**

1. Click **"Hand-to-hand"**.
2. A remote session opens, allowing you to interact with the machine's graphical interface.

**When to use**

- To intervene manually.
- To diagnose a specific problem.
- When no other automated action is enough.

##### **10. Manage relay rules**

**Objective**  
Consult, modify or add specific operating rules to a relay.

**Procedure**

**[![settings.png](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/s2Fsettings-png.png)](https://docs.medulla-tech.io/uploads/images/gallery/2025-05/scaled-1680-/s2Fsettings-png.png)**

1. Click **"Relay rules" (last working image)**
2. From the interface:
    
    
    - View existing rules.
    - Change or delete outdated rules.
    - Add new rules as needed.

**When to use**

- To automate repetitive actions.
- To dynamically adapt the relay behavior to a specific use.