8378cfe5 featured anyx admin resourcesssh

SSH

The SSH pages (routes /ssh-overview and /ssh-new) manage secure shell resources. SSH (Secure Shell) is a remote command-line interface for system management. An SSH resource exposes an SSH service on your private network so users can connect with their SSH client, without a virtual private network and without exposing the service to the internet. See Resources (concepts) and End-user experience for where SSH fits in the platform.

Purpose

An SSH resource tells the platform where an SSH service lives (host and port inside your network) and which connector fronts it. When a user connects with their SSH client, an SSH gateway proxies the connection through the connector to that address. Users authenticate with their own credentials; optionally, the platform can log users in automatically when they use the browser.

The SSH overview lists every SSH resource, its address, port, connector and policies, and lets you create, edit and delete them. The New SSH wizard steps through the connector, name, address, advanced options, a review and a done step.

Why use it

Give administrators and developers command-line access to internal machines with no public IP and no inbound firewall rules. See Zero trust architecture.
Let users reach SSH services through the launcher or through a browser, with the platform handling authentication and audit.
Offer automatic sign-in for the browser flow using stored credentials (username and password, or a private key with optional passphrase).
Keep every connection audited, and control access with permissions and policies like any other resource.

When to use it

When users need secure shell access to servers that live inside your private network.
When you want to remove direct inbound SSH exposure and move access behind the identity-aware proxy.
Whenever you add, change or remove an SSH resource, or change how users authenticate to it.

Prerequisite: permission to administer SSH resources (an owner or administrator role). Without it, the page shows a no permissions message.

How to use it

SSH overview

Open Resources > SSH > Overview from the left navigation.

The table lists every SSH resource with its name, address, port, connector, policies and an actions menu. The name, address and port cells are editable inline. Use the search box to filter the table, and the toolbar buttons to ADD SSH or delete selected rows.

Open the more menu on an SSH row for the row actions:

Search in Audits: jumps to the audit subsystem filtered to this SSH resource.
Manage Credentials: opens the credentials dialog to change the username, password, private key and private key passphrase.
Configure Policies: attaches policies to the SSH resource.

Creating an SSH resource with the wizard

Open Resources > SSH > New. The wizard has six steps: Select connector, SSH name, Address, Advanced configuration (optional), Apply, and Done.

#### Step 1: Select connector

Choose the connector that fronts the SSH service. If you have not created one, use Resources > Connectors > New first, then return and select it.

#### Step 2: SSH name

Enter the SSH name. The tooltip explains that this name uniquely identifies the SSH resource within this organisation. It must be a valid hostname, because it becomes part of the address users connect to.

#### Step 3: Address

Enter the address of the SSH service in your remote network (hostname or IP) and the port. An SSH gateway proxies requests from the client through to this address via the connector. The port defaults to 22.

#### Step 4: Advanced configuration (optional)

Choose whether your users should log in automatically when using the browser. Choosing Yes reveals the credentials the gateway uses:

My SSH server’s default user is: the username used for automatic sign-in;
Private key: an SSH private key, pasted or uploaded with the menu beside the field;
private key passphrase: the passphrase for the private key, if it has one;
password: a password for the SSH server, if key-based sign-in is not used.

#### Step 5: Apply

Review the summary, which restates the connector, SSH name, address, port and username. Select APPLY to create the SSH resource. Creation runs asynchronously; the wizard advances to Done automatically when it succeeds.

#### Step 6: Done

The Done step confirms the SSH resource was created and offers to add it to resource groups, assign permissions, and add it to policies.

Fields and controls reference

Control	Purpose	Required	Default	Valid values	Notes
Name	The SSH resource’s unique name	Yes	n/a	A valid hostname, no spaces	Becomes part of the connection address
Address	Hostname or IP of the SSH service	Yes	n/a	Hostname or IP	Proxied through the connector
Port	Port the SSH service listens on	Yes	22	A port number
Connector	Connector fronting the service	Yes	n/a	A configured connector
Automatic sign-in	Log users in automatically in the browser	No	No	Yes, No	Advanced configuration
Username	Default user for automatic sign-in	When automatic	n/a	A user on the SSH server
Private key	SSH private key for key-based sign-in	No	n/a	PEM key material	Pasted or uploaded
Private key passphrase	Passphrase for the private key	No	n/a	Any text	Only if the key has one
Password	Password for password sign-in	No	n/a	Any text	Used when no private key

Dialogs and popups

Manage Credentials dialog: opened from the row menu’s Manage Credentials. It shows the username, password, private key (with an upload menu) and private key passphrase, with SAVE, DELETE and CANCEL.

Configure Policies dialog: the two-pane policy assignment dialog shared by all resources. See Policies.
Confirmation dialog: deleting an SSH resource confirms before acting.

Configuration versus diagnostics versus confirmation

Configuration: creating SSH resources, inline edits, automatic sign-in credentials, and the private key are persistent configuration.
Diagnostics: use Search in Audits from the row menu to see connection attempts and outcomes.
Confirmation: deleting an SSH resource is permanent and removes access for everyone who relies on it. Confirm before proceeding.

Pagination and async behaviour

The SSH overview pages at 25 rows per page; the paginator shows the current page and totals. The demo organisation had no SSH resources when captured.
SSH resource creation runs asynchronously. After selecting APPLY, wait a few seconds; the wizard advances to Done automatically. New resources appear on the overview shortly after creation.
Inline cell edits save when you blur the field; wait a few seconds and reload to confirm the change.

Troubleshooting

The SSH resource will not create: check the name is a valid hostname, the address and port are present, and a connector is selected. Validation errors appear on the relevant step.
Users cannot connect: check the connector status on the Connectors overview, confirm the address and port are reachable from the connector’s network, and confirm the credentials with Manage Credentials.
Automatic sign-in fails: confirm the default user exists on the SSH server and that the private key (and its passphrase) or password is correct.
A connection shows in audits as denied: check the user’s permissions and any policies attached to the SSH resource.

SSH