> For AI agents: the complete documentation index is available at https://www.jumpserver.com/docs/llms.txt, the full documentation bundle is available at https://www.jumpserver.com/docs/llms-full.txt.

# Platforms

A platform describes the system type of an asset: how JumpServer connects to
it, which protocol and port to use, how characters are encoded, and which
automation methods are valid. Platforms are selectable when an asset is created,
so the platform list is the catalog of asset types available in the console.

## Overview

JumpServer ships with built-in platforms for Linux, Windows, network devices,
databases, and web applications. Built-in platforms cover the most common
connection and automation behavior and are ready to use.

Create a custom platform when you need a variant of a system type, for example a
Linux platform with a different default port, a GBK encoding, account switching
enabled, or a restricted set of protocols. A custom platform is based on an
existing platform, so it inherits behavior you do not have to redefine.

## Create a platform


1

In the right area of the top navigation bar, click .

![image](/docs/images/docs/navs/nav-settings.png)

2

In the left menu, click 
**Platforms**
.

3

Click 
**Create**
.

4

Type a **Name** and select the base platform in the **Type** field. The type
determines the available protocols and automation methods.

5

Set the encoding, domain support, and protocols described in the field
reference.

6

Click **Submit**. The new platform is now selectable when an
[asset](https://www.jumpserver.com/docs/features/console/assets/index.md) is created.

![Figure 1: Platforms list](/images/v5/jumpserver/v5_settings_platforms_list_01.png)

## Field reference

| Field               | Description                                                                                                                                            |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name                | Platform name shown in the asset form.                                                                                                                 |
| Type                | Base system type. It determines the encoding options and the automation methods that the platform supports.                                            |
| Encoding            | Character encoding used for terminal sessions. `UTF-8` or `GBK`.                                                                                       |
| Enable domain       | Allows assets on this platform to be reached through a domain gateway. Some platform types do not support domains, and the option is then unavailable. |
| Supported protocols | Protocols and default ports exposed by the platform. The default protocol of a platform cannot be removed, but its port can be changed.                |
| Account switching   | Enables `sudo su -` or `su -` switching for accounts on this platform.                                                                                 |
| Automation          | Ansible settings and the interaction methods used by automation tasks.                                                                                 |

## Protocol and automation settings

The protocol section determines how users connect. Add a protocol only when the
target system and the corresponding client component support it.

The automation section is used by PAM automation tasks. When enabled, the
platform defines the default method for each capability:

| Capability         | Purpose                                                                                                                                      |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Asset probe        | Checks whether the asset is reachable and records connectivity state.                                                                        |
| Collect asset info | Reads hardware and system information from the asset.                                                                                        |
| Change secret      | Changes the password of an asset account; used by [Change Secrets](https://www.jumpserver.com/docs/features/pam/security/change-secrets.md). |
| Push account       | Creates or updates accounts on the asset.                                                                                                    |
| Verify account     | Checks that stored credentials are still valid.                                                                                              |
| Collect accounts   | Discovers existing accounts on the asset.                                                                                                    |

![Figure 2: Platform detail and automation options](/images/v5/jumpserver/v5_settings_platforms_detail_01.png)

## Custom SFTP root path

SFTP sessions start in `/tmp` by default. To use another directory:


1

Add the SFTP protocol while creating or editing the platform.

2

Click the gear icon next to the protocol configuration.

3

Set the **SFTP root path** and submit the platform.


Note

Protocol and automation settings become defaults for assets created on the
platform. Changing a platform later does not rewrite the per-asset settings
that were already saved.