App Ports
|
This module is currently unavailable and will be available in future versions. The documentation below is provided for reference only. |
App Ports (Application Ports) is where operators manage port mapping rules for applications and services in the Angular Console. Each entry defines how an internal port is mapped to an external port for a selected Client Type and protocol. Because incorrect port rules can cause connectivity issues, use small, reversible steps and always rely on export and dry-run before applying bulk changes.
When to use this module
Use App Ports when you need to:
-
review existing port rules for a Client Type,
-
open a rule to confirm internal/external mapping and protocol,
-
export a snapshot as a backup before changes,
-
import bulk changes from a prepared file (with mandatory dry-run),
-
create, edit, or delete a rule (if permitted),
-
verify what changed after an import or edit.
Prerequisites
-
Select a Client Type (DEF / MC / SC). App Ports is scoped to the selected Client Type.
-
Confirm your permissions:
-
VIEWER — browse (read-only).
-
EDITOR / ADMIN — create, edit, delete, import.
If you don’t see New / Import / Edit actions, it’s a permissions issue.
-
Navigation path
-
Angular Console → App Ports
Before changing anything, verify the current context (environment and Client Type). A wrong Client Type means you change the wrong scope.
What an App Port entry contains
An App Port entry (port rule) includes:
- Description
-
A short human-readable label. Required; maximum 255 characters.
- Internal Port
-
The internal port number (integer 1–65535). Example UI placeholder:
8080. - External Port
-
The external port number (integer 1–65535). Example UI placeholder:
80. - Protocol
-
Transfer protocol for the rule:
TCPorUDP. - Client Type
-
The scope the rule belongs to (DEF / MC / SC). When editing an existing rule, Client Type is fixed.
- ID and history (read-only)
-
The rule ID and audit metadata such as Created/Updated timestamps (and author when available).
In the details view, the UI may mark ports in the 49152–65535 range as an Ephemeral port.
|
Common tasks
Browse and open details
-
Open App Ports.
-
Select the required Client Type.
-
Browse the list of port rules.
-
Click a row to open Port Details.
What you should see:
-
a paginated table (newest rules first),
-
columns such as ID, Description, Internal Port, External Port, and Protocol,
-
a Port Details dialog showing the mapping
internal → external (protocol)and history, -
read-only mode for VIEWER accounts (write actions hidden/disabled).
| Use the list pagination controls to move between pages and adjust page size. |
Create a new rule (EDITOR / ADMIN)
-
Click New Port.
-
Select the required Client Type.
-
Fill in Description, Internal Port, External Port, and Protocol.
-
Click Create.
-
Return to the list and open the new rule to confirm it was saved.
The create form defaults to Internal Port 8080, External Port 80, Protocol TCP.
Always overwrite these defaults to match your intended rule.
|
Edit an existing rule (EDITOR / ADMIN)
-
Open a rule (from the list) to view Port Details or open the Edit Port page.
-
Click Edit.
-
Update the fields you need.
-
Click Save.
-
Re-open the rule to confirm the updated values.
App Ports validates basic constraints (required description, ports must be integers within 1–65535, protocol must be TCP/UDP).
Fix field-level errors before saving.
|
Export ports (snapshot)
-
Open App Ports.
-
Select the required Client Type.
-
Click Export Ports.
-
Save the downloaded JSON file.
What is exported:
-
the full set of App Port rules for the selected Client Type (not only the current page).
For details, see: Export a Snapshot.
Import with dry-run (mandatory)
Import is the safest way to apply many changes at once. Always follow the workflow: export → dry-run → apply.
-
Export a snapshot first (recommended): Export a Snapshot.
-
Select the required Client Type.
-
Click Import Ports.
-
Select an Import Mode:
-
Merge — adds/updates rules without replacing the entire set.
-
Replace — replaces all rules in the selected Client Type.
-
-
Select a
.jsonfile (max 10MB). -
Dry-run starts automatically after file selection (and re-runs when you change the import mode).
-
Review the dry-run preview:
-
summary counts (to add / update / delete / skip),
-
duplicates (if reported),
-
per-rule details grouped by status (when provided by the backend),
-
errors and warnings.
-
-
Click Confirm import only when the preview matches your intent.
Import safety checklist
-
Confirm you are in the correct environment.
-
Confirm your selected context (for example, client type) matches the file.
-
Export a snapshot before changes.
-
Run Dry-run and review:
-
errors (must be resolved),
-
warnings (understand impact),
-
create/update/delete counts.
-
-
If using REPLACE, confirm you accept deletions shown in the dry-run plan.
-
Apply import and immediately verify by refreshing and re-opening the affected entries.
| Replace can delete rules that are not present in the imported file. Treat any unexpected deletions as a stop signal until you confirm the file is complete and the selected Client Type is correct. |
Export is a good starting point for preparing an import file.
The import schema focuses on description, internalPort, externalPort, and protocol; extra exported fields (like IDs) are ignored by the importer.
|
After-change verification checklist
-
Confirm you are in the intended environment.
-
Confirm the selected Client Type (DEF / MC / SC).
-
Return to the App Ports list and confirm the expected rule count and entries are present.
-
Re-open the changed rule(s) and verify:
-
Internal Port and External Port values,
-
Protocol (TCP/UDP),
-
mapping preview
internal → external.
-
-
If you used Replace, spot-check a few rules you expected to remain (to confirm nothing was unintentionally removed).
-
(Optional) Export a new snapshot for audit: Export a Snapshot.
Troubleshooting
- No ports shown for a Client Type
-
Confirm you selected the intended Client Type. If the list is still empty, it may mean there are no rules defined for that scope.
- I don’t see New / Import / Edit actions
-
You are likely signed in as VIEWER. Ask an administrator to grant EDITOR/ADMIN access.
- Export doesn’t work in read-only mode
-
Some deployments may restrict export for VIEWER accounts. If clicking Export Ports does nothing, request elevated access.
- Save is disabled
-
Fix field validation errors. App Ports requires Description, integer ports within
1–65535, and a valid protocol (TCPorUDP). - Dry-run says the file is invalid
-
App Ports import accepts
.jsonfiles only (max 10MB). Use Export as the base, edit it, and re-upload. - Dry-run shows errors or duplicates
-
Fix the reported issues in the file (for example, remove duplicate entries or correct invalid values), then select the file again to re-run dry-run.
- Dry-run shows many deletions
-
You likely selected Replace, or the file is incomplete for the selected Client Type. Regenerate the file from Export and retry.
- Import succeeds but the list doesn’t look updated
-
Close the import dialog, re-open the App Ports page (or switch Client Type away and back) and check again. Also ensure you imported into the intended Client Type.