# Commands

\
The **Commands** tab of a Module, provides a direct way to invoke specific functionality on a module without requiring a re-deployment.

\
Think of the Commands Tab as an **interactive API testing console** built into the Nexus interface - allowing you to send JSON payloads to the module and receive immediate responses.

<figure><img src="/files/mhJvIXgzPntpg3lp348h" alt=""><figcaption><p>Showing the Commands page/tab for the FileTranferModule</p></figcaption></figure>

{% hint style="info" %}
The **Commands** tab is only available for modules that support the **Nexus SDK**
{% endhint %}

***

### Key UI Elements

* **Command Drop-down** - Lists all available commands for the selected module
* **Refresh** – Updates the list of commands in case new ones are exposed
* **Show Schema** – Displays the JSON Schema defining the exact structure of the required payload
* **Payload Field** – A text editor where you insert the JSON payload that will be sent to the module
* **Send Payload** – Executes the selected command with the provided payload
* **Response Panel** – Displays the response returned by the module

***

### How It Works

When a module is developed with the Nexus SDK, its developer can **expose one or more commands**.\
These commands become available in the **Commands** tab for that module.

From here, you can:

1. Select a command from the **Command** drop-down menu.
2. (Optional) Click **Show Schema** to see the JSON Schema for the expected payload format.

<figure><img src="/files/VSV5WZcan07Nuqf92xyk" alt=""><figcaption><p>Showing Json Schema for the ListBlobs Command of the FileTransferModule</p></figcaption></figure>

3. Enter/Fill out the JSON payload in the **Payload** section

<figure><img src="/files/ZBc0kgTBHig3b2Qyv7lv" alt=""><figcaption><p>Enter the expected Json payload based on the Schema</p></figcaption></figure>

4. Click **Send Payload** to execute the command on the module
5. View the **Response** in the right-hand panel

<figure><img src="/files/1vfP0u2A6CzUZymNUWiX" alt=""><figcaption><p>Showing the Response from sending the Payload to the Command</p></figcaption></figure>

***

### Use Cases

The Commands tab is particularly useful for:

* **Debugging and Troubleshooting** – Test module behavior with different inputs to identify and resolve issues quickly.
* **Rapid Iteration** – Try different configurations or trigger specific actions without a full redeployment.
* **Operational Tasks** – Manually invoke data synchronization, file listing, or other module-specific functions.

***

### Important Notes

* Only modules developed with the **Nexus SDK** will expose commands in this tab
* Payloads must strictly follow the JSON Schema format provided by **Show Schema**
* Incorrect payload formatting can result in command execution errors
* Changes made through commands are **runtime actions** - they do not permanently alter the module configuration unless the module is designed to store state


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tricloudnexus.io/management-portal/operations/monitoring/module-details/commands.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
