### Example HA Configuration - Backup Node

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/ha.html

Example commands for configuring backup nodes in a high availability setup, including setting IDs, IP addresses, ports, and intervals.

```bash
set ha id 2
set ha ip 192.0.2.11
set ha port 322
set ha interval 500
```

```bash
set ha id 3
set ha ip 192.0.2.12
set ha port 322
set ha interval 500
```

--------------------------------

### Install Image

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Installs an existing image in the `img` format from the specified path.

```bash
vamgr install <path_to_image>
```

--------------------------------

### Example SNMP Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/snmp.html

An example demonstrating a complete SNMP configuration, including listener, community, access level, description, and location settings.

```bash
set snmp listener 192.0.2.1 161 TCP
set snmp listener 192.0.2.1 161 UDP
set snmp community SNMPcom 0.0.0.0/0
set snmp community SNMPcom 0.0.0.0/0 access RW
set snmp description "TDC 1"
set snmp location "Data Center"
```

--------------------------------

### Example HA Configuration - Master Node

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/ha.html

Example commands for configuring the master node in a high availability setup, including setting IDs, IP addresses, ports, intervals, and the shared cluster IP.

```bash
set ha id 1
set ha ip 192.0.2.10
set ha port 322
set ha interval 500
set ha cluster-ip 192.0.2.1
```

--------------------------------

### Example: Create Rule Set for Group

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/management-system.html

This example demonstrates creating a user group, a rule set, and assigning permissions to allow all actions for that group.

```bash
set groups name users
set rule-list allow-change group users
set rule-list allow-change rule allow-change
set rule-list allow-change rule allow-change action permit
set rule-list allow-change rule allow-change access-operations *
```

--------------------------------

### Example Real Server Pool Configuration by IP

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/real-server.html

An example demonstrating the configuration of a Real Server Pool using IP addresses, including setting the ID, assigning a real server with weight, specifying an IP set, assigning a health check, and adding a description.

```bash
set id rs_port_22
set id rs_port_22 rs 192.0.2.1 22 weight 1
set id rs_port_22 ipset-id ha_node_1
set id rs_port_22 hc-id combo
set id rs_port_22 description "tcp rs"
```

--------------------------------

### List Installed Images (Simple Format)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Displays a simple, unformatted list of installed images. This is useful for scripting or quick checks.

```bash
vamgr list -p
```

--------------------------------

### Example HTTP Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

A comprehensive example demonstrating the configuration of an HTTP health check with various parameters.

```bash
set health-check id http_hc
set health-check id http_hc HTTP
set health-check id http_hc HTTP interval 10
set health-check id http_hc HTTP timeout 5
set health-check id http_hc HTTP try 1
set health-check id http_hc HTTP success-try 1
set health-check id http_hc HTTP source-ip 192.0.2.1
set health-check id http_hc HTTP method POST
set health-check id http_hc HTTP uri /
set health-check id http_hc HTTP status-codes 200
set health-check id http_hc HTTP status-codes 202
set health-check id http_hc HTTP response-string
set health-check id http_hc HTTP headers Host:123
set health-check id http_hc HTTP reverse false
```

--------------------------------

### Example TCP Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

A complete example demonstrating the sequence of commands to configure a new TCP health check with specific parameters.

```bash
set health-check id tcp-new
set health-check id tcp-new TCP
set health-check id tcp-new TCP interval 10
set health-check id tcp-new TCP timeout 5
set health-check id tcp-new TCP try 1
set health-check id tcp-new TCP success-try 1
set health-check id tcp-new TCP target-port 88
```

--------------------------------

### Example HTTPS Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

A complete example demonstrating the configuration of an HTTPS health check with various parameters.

```bash
set health-check id https_hc
set health-check id https_hc HTTP
set health-check id https_hc HTTP interval 10
set health-check id https_hc HTTP timeout 5
set health-check id https_hc HTTP try 1
set health-check id https_hc HTTP success-try 1
set health-check id https_hc HTTP source-ip 192.0.2.1
set health-check id https_hc HTTP method POST
set health-check id https_hc HTTP uri /
set health-check id https_hc HTTP status-codes 200
set health-check id https_hc HTTP status-codes 202
set health-check id https_hc HTTP response-string
```

--------------------------------

### Example Python Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

This example demonstrates a complete configuration for a user health check using a Python script.

```bash
set health-check id user01
set health-check id user01 USER
set health-check id user01 USER interval 7
set health-check id user01 USER timeout 5
set health-check id user01 USER try 2
set health-check id user01 USER success-try 2
set health-check id user01 USER script httptcp.py
```

--------------------------------

### Upgrade Image from Archive

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Installs a new image from a `.tar.gz` archive. The installed image automatically gets priority for loading.

```bash
vamgr upgrade <archive_path>
```

--------------------------------

### Default NACM Configuration Example

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/management-system.html

Provides an example of the default Network Access Control Management (NACM) configuration, including enabled NACM, default read/write/exec permissions, and rule lists for admin and operator roles.

```bash
set nacm enable-nacm true
set nacm read-default deny
set nacm write-default deny
set nacm exec-default deny
set nacm rule-list admin
set nacm rule-list admin group tdadmin
set nacm rule-list admin rule allow-all
set nacm rule-list admin rule allow-all path /
set nacm rule-list admin rule allow-all access-operations *
set nacm rule-list admin rule allow-all action permit
set nacm rule-list operator
set nacm rule-list operator group tdoperator
set nacm rule-list operator rule allow-read
set nacm rule-list operator rule allow-read path /
set nacm rule-list operator rule allow-read access-operations read
set nacm rule-list operator rule allow-read action permit
```

--------------------------------

### List Installed Images

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Displays a list of all images currently installed on the system. This provides an overview of available images.

```bash
vamgr list
```

--------------------------------

### Example ICMP Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

A complete example demonstrating the configuration of an ICMP health check with various parameters.

```bash
set health-check id icmp-new
set health-check id icmp-new ICMP
set health-check id icmp-new ICMP interval 10
set health-check id icmp-new ICMP timeout 5
set health-check id icmp-new ICMP try 1
set health-check id icmp-new ICMP success-try 1
set health-check id icmp-new ICMP target-ip 192.0.2.10
```

--------------------------------

### Example Bash Health Check Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

This example shows a complete configuration for a user health check using a Bash script, including a target IP address.

```bash
set health-check id user02
set health-check id user02 USER
set health-check id user02 USER interval 5
set health-check id user02 USER timeout 2
set health-check id user02 USER try 2
set health-check id user02 USER success-try 2
set health-check id user02 USER target-ip 192.0.2.10
set health-check id user02 USER script httptcp.sh
```

--------------------------------

### Example HA Configuration - Remote Node Interaction

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/ha.html

Example commands for configuring the interaction parameters between Termidesk Connect nodes in a high availability cluster, specifying remote node names and their identifiers.

```bash
set ha remote NodeTDC15-2 id 2
```

```bash
set ha remote NodeTDC15-1 id 1
```

--------------------------------

### Verify Running Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Displays the current running configuration of the dynamic routing setup. Use this to confirm changes.

```bash
show running-config
```

--------------------------------

### Listing Backup Copies with Metadata

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Displays a list of backup copies, including comment, author, and email address information. The example shows the format of the output.

```bash
snag list -c -a -e
> 45b768a 2025-08-13 14:21:02 Created standard snapshot     snag user@site.domain
```

--------------------------------

### Create Virtual Server for TCP Balancing

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/set/object-vs.html

Creates a Virtual Server for TCP load balancing. Configuration is identical to HTTP setup, with the exception of HTTP-specific profiles.

```APIDOC
## set vs TCP <name>

### Description
Creation of Virtual Server for balancing using the TCP protocol. The setup is identical to the HTTP setup, except:
* `http-profile-id` (not applicable for this type of Virtual Server);

### Method
APICALL

### Endpoint
set vs TCP <name>
```

--------------------------------

### Lua Path Matching

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/lua.html

Examples of Lua expressions for matching URL paths.

```lua
if client.http_req.path == "/abcZxc"
```

```lua
if client.http_req.path == "/abc"
```

```lua
if (client.http_req.path:find("zx"))
```

--------------------------------

### Displaying snag Tool Help Information

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Execute this command to get information on the main commands of the snag tool.

```bash
snag -h
```

--------------------------------

### Show configuration cli ip with grep

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-show.html

Example of using 'show configuration cli ip' and piping the output to 'grep' to filter for specific lines containing 'ha-type LOCAL'.

```bash
show configuration cli ip | grep ha-type LOCAL
```

```bash
set ip address 192.0.2.120 /24 ha-type LOCAL
set ip route vrf_custom 198.51.100.1/24 203.0.113.10 ha-type LOCAL
```

--------------------------------

### Python Health Check Script Example

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/script-healthcheck.html

This script performs an HTTP GET request to a target address and port, exiting with code 0 on success. It requires the 'requests' library and parses JSON arguments.

```python
import requests
import sys
import json

config = json.loads(sys.argv[1])
target_ip = config["target-ip"]
target_port = config["target-port"]

response = requests.get(f"http://{target_ip}:{target_port}", timeout=5)
response.raise_for_status()
sys.exit(0)
```

--------------------------------

### Initializing Backup Repository with Overwrite

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Initializes a backup repository, overwriting any existing repository.

```bash
snag init -f
```

--------------------------------

### Initializing a Backup Repository

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Initializes a repository for storing backup copies using the snag tool.

```bash
snag init
```

--------------------------------

### Create a Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Use this command to create a new Virtual Server for RAPID-UDP load balancing. Replace `<name>` with a unique identifier for your server.

```bash
set vs RAPID-UDP <name>
```

--------------------------------

### Create a Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Use this command to create a new Virtual Server for RAPID-TCP load balancing. Replace `<name>` with the desired name for your virtual server.

```bash
set vs RAPID-TCP <name>
```

--------------------------------

### Show command with utility piping

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-show.html

Demonstrates piping the output of the 'show' command to a standard utility for further processing.

```bash
show <option> <parameters> | <utility>
```

--------------------------------

### Show configuration in different formats

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-show.html

Displays the Termidesk Connect working configuration, with options to format the output as CLI commands, JSON, NETCONF, plain text, or XML.

```bash
show configuration <format> <object>
```

--------------------------------

### Create KDC Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/aaa.html

Initiate the creation of a KDC server configuration with a given name. This is the first step in setting up Kerberos authentication.

```bash
set krb5 server <name>
```

--------------------------------

### Vault KV v2 Secret Creation

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/openbao.html

Example command to put a secret into a KV v2 engine. Used to demonstrate retrieval in Example 2.

```bash
vault kv put secret/snmp username="snm-user" auth_key="authkey" priv_key="privkey"
```

--------------------------------

### Install Image with UUID Modification

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Installs an existing `img` format image while modifying its device image unique identifier. This is useful for creating distinct copies.

```bash
vamgr install --mod-uuid <path_to_image>
```

--------------------------------

### Create Role for Certificate Issuance

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/openbao.html

Use this command to enable the PKI secrets engine and create a role named 'example-dot-com' with specified domain and subdomain allowances, and a maximum TTL.

```bash
vault secrets enable pki
    vault write pki/roles/example-dot-com\
    allowed_domains="example.com" \
    allow_subdomains=true \
    allow_bare_domains=true \
    max_ttl=72h
```

--------------------------------

### Vault KV v1 Secret Creation

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/openbao.html

Example commands to enable KV version 1 and put a secret. Used to demonstrate retrieval in Example 1.

```bash
secrets enable -version=1 -path=legacy kv
vault kv put legacy/snmp username="snm-user" auth_key="authkey" priv_key="privkey"
```

--------------------------------

### Basic show command format

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-show.html

The fundamental structure for using the 'show' command with an option and optional parameters.

```bash
show <option> <parameters>
```

--------------------------------

### Get vamgr Tool Help

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

To get information on the basic commands for the vamgr tool, run this command. You can use -h or --help with any command for detailed help.

```bash
vamgr -h
```

--------------------------------

### View Load Balancing Server Configuration Commands

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/balancing-server.html

Display the executed commands for configuring a RAPID-TCP Load Balancing Server.

```bash
show configuration cli lbs RAPID-TCP <name>
```

--------------------------------

### View Virtual Server Configuration (XML)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Display the configured settings for a specific HTTP Virtual Server in XML format.

```bash
show configuration xml vs HTTP <name>
```

--------------------------------

### View Real Server Pool Configuration in XML

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/real-server.html

Displays the configured settings for a Real Server Pool in XML format.

```bash
show configuration xml rs-pool id <name>
```

--------------------------------

### Lua Hostname Matching

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/lua.html

Example of Lua expression for extracting a subdomain from a hostname.

```lua
(client.http_req.host:match("(.*).123.ru")
```

--------------------------------

### Create Load Balancing Server (RAPID-UDP)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/balancing-server.html

Use this command to create a new Load Balancing Server for the RAPID-UDP protocol. Replace `<name>` with the desired name for your server.

```bash
set lbs RAPID-UDP <name>
```

--------------------------------

### Create Server SSL Profile

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/tls.html

Use this command to create a new Server SSL Profile. Replace `<profile_name>` with a unique name for your profile.

```bash
set ssl-profile server <profile_name>
```

--------------------------------

### View Network Interface Configuration (XML)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Retrieve the configured network interface settings in XML format. Replace <name> with the interface name.

```bash
show configuration xml ethernet name <name>
```

--------------------------------

### Specify AAA Server LDAP Base DN

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/aaa.html

Configure the root point of the directory service, for example, 'DC=myserver,DC=local'.

```bash
set aaa server <name> LDAP base-dn <base_dn>
```

--------------------------------

### Drop Connection Based on HTTP Method (Lua)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/lua.html

Drops the connection if the HTTP request method is neither GET nor HEAD.

```lua
if (client.http_req.method ~= "GET" and client.http_req.method ~= "HEAD") then
    client.action = "drop"
end
```

--------------------------------

### Show command with less utility

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-show.html

Shows how to use the 'less' utility with the 'show' command for paginated output and searching.

```bash
show <option> <parameters> | less
```

--------------------------------

### Create HTTP Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/set/object-vs.html

Use this command to create a new Virtual Server for HTTP balancing. Specify the name for the new server.

```bash
set vs HTTP <name>
```

--------------------------------

### OpenBao Certificate Generation Response

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/openbao.html

This is an example of the JSON response received after successfully generating a certificate, including the certificate, issuing CA, and private key.

```json
{
    "request_id": "e86ed1f5-f7bb-1f6a-a864-6a5540c92191",
    "lease_id": "",
    "renewable": false,
    "lease_duration": 0,
    "data": {
        "certificate": "-----BEGIN CERTIFICATE....",
        "issuing_ca": "-----BEGIN CERTIFICATE-----...",
        "private_key": "-----BEGIN RSA PRIVATE KEY-----..."
        },
    "wrap_info": null,
    "warnings": null,
    "auth": null,
    "mount_type": "pki"
}
```

--------------------------------

### Create Client SSL Profile

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/tls.html

Use this command to create a new Client SSL Profile. A minimal configuration is applied by default.

```bash
set ssl-profile client <name>
```

--------------------------------

### View HTTP Profile Configuration in XML

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/profiles.html

View the configured settings for a specific Client HTTP Profile in XML format.

```bash
show configuration xml http-profile client <name>
```

--------------------------------

### Specify Request Method for Health Check

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/healthcheck.html

Sets the HTTP request method for the health check. Defaults to 'HEAD'. Possible values are GET, HEAD, POST.

```bash
set health-check id <name> HTTP method <request-method>
```

--------------------------------

### Assign LAG Interface Type

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Assign the type of protocol for the LAG interface. LACP is used for dynamic negotiation, while Active-backup uses a primary/secondary link setup.

```bash
set aggregation name <name> type <type>
```

--------------------------------

### Create Load Balancing Server (RAPID-TCP)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/balancing-server.html

Use this command to create a new Load Balancing Server for RAPID-TCP traffic. Replace <name> with the desired name for your server.

```bash
set lbs RAPID-TCP <name>
```

--------------------------------

### Configure All Ports for Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Configure the Virtual Server to listen on all ports. Replace `<name>` with the virtual server's name.

```bash
set vs RAPID-TCP <name> vip port 0
```

--------------------------------

### Set High Availability Type for Route

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Configure the synchronization type for a route in a high availability setup. Use 'LOCAL' for local configuration or 'SHARED' for redundant configuration synchronization.

```bash
set ip route <name_VRF> <IP_address><prefix_length> <gateway_IP_address> ha-type <value>
```

--------------------------------

### Set VLAN High Availability Type

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Configures the synchronization type for a VLAN in a high availability setup. 'LOCAL' means it's only in the local configuration, while 'SHARED' synchronizes it for redundancy.

```bash
set vlan name <name> ha-type <value>
```

--------------------------------

### Configure Remote HA Nodes

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/ha.html

Configure the IP address, port, and security key for remote nodes participating in the high availability setup. Ensure these settings are consistent across all nodes.

```bash
set ha remote NodeTDC15-2 ip 192.0.2.11
set ha remote NodeTDC15-1 ip 192.0.2.10
set ha remote NodeTDC15-1 ip 192.0.2.10
```

```bash
set ha remote NodeTDC15-2 port 322
set ha remote NodeTDC15-1 port 322
set ha remote NodeTDC15-1 port 322
```

```bash
set ha remote NodeTDC15-2 seckey P@ss
set ha remote NodeTDC15-1 seckey P@ss
set ha remote NodeTDC15-1 seckey P@ss
```

```bash
set ha remote NodeTDC15-3 id 3
set ha remote NodeTDC15-3 id 3
set ha remote NodeTDC15-2 id 2
```

```bash
set ha remote NodeTDC15-3 ip 192.0.2.12
set ha remote NodeTDC15-2 ip 192.0.2.11
set ha remote NodeTDC15-2 ip 192.0.2.11
```

```bash
set ha remote NodeTDC15-3 port 322
set ha remote NodeTDC15-2 port 322
set ha remote NodeTDC15-2 port 322
```

--------------------------------

### Configure Port Range for Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Set a range of ports for the Virtual Server to listen on, useful for balancing connections across multiple ports. Specify the start and end of the range.

```bash
set vs HTTP <name> vip portrange from <start_range>
```

```bash
set vs HTTP <name> vip portrange to <end_range>
```

--------------------------------

### Set High Availability Type for IP Address

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/network.html

Configure the synchronization type for an IP address in a high availability setup. Use 'LOCAL' for local configuration or 'SHARED' for high availability synchronization.

```bash
set ip address <IP-address> /16 ha-type <value>
```

--------------------------------

### View User Configuration (XML)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/management-system.html

Displays the configuration settings for a specific user in XML format.

```bash
show configuration xml user name <name>
```

--------------------------------

### Specify Private Key File for Server Certificate

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/tls.html

Configure the private key file corresponding to the server certificate. Specify the full file name with extension.

```bash
set ssl-profile server <profile_name> host <name> setting key <file_name>
```

--------------------------------

### Set Current Node to Active State

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/command-ha.html

Use this command to transfer the current node to an active state, making it the master node. This is useful for manually promoting a node in a high availability setup.

```bash
ha set-active
```

--------------------------------

### View Load Balancing Server Configuration (CLI)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/balancing-server.html

Displays the executed commands for configuring a specific TCP load balancing server.

```bash
show configuration cli lbs TCP <name>
```

--------------------------------

### Add Multiple Headers and Redirect Request (Lua)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/lua.html

Adds 'Remote-port' and 'XFF' headers and redirects the request to 'lb1' if the host name starts with 'abc'. Includes a helper function for prefix checking.

```lua
function startswith(text, prefix)
  return text:find(prefix, 1, true) == 1
end

if startswith(client.http_req.host, "abc") then
  client.http_req.header:field_set("Remote-port", client.remote_p.port)
  client.http_req.header:field_set("XFF", client.remote_p.ip)
  client.bs = "lb1"
  client.action = "bs"
end
```

--------------------------------

### Creating Backup Copy with Metadata

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Creates a new backup copy while specifying a comment, author, and email address. The output confirms successful snapshot creation.

```bash
snag create -c <comment> -a <author> -e <email>
Snapshot created successfully: 45b768a
```

--------------------------------

### Configure Port Range for Virtual Server

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Set a range of ports for the Virtual Server to listen on. Replace `<name>` with the virtual server's name, `<start_range>` with the starting port, and `<end_range>` with the ending port.

```bash
set vs RAPID-TCP <name> vip portrange from <start_range>
```

```bash
set vs RAPID-TCP <name> vip portrange to <end_range>
```

--------------------------------

### Upgrade Image Without Removing Old Version

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Installs a new image from a `.tar.gz` archive without removing the `img` format image if errors occur during unpacking. This preserves the previous version in case of issues.

```bash
vamgr upgrade --not-remove <archive_path>
```

--------------------------------

### View Virtual Server Configuration (XML)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/virtual-server.html

Display the configuration of a specific TCP Virtual Server in XML format.

```bash
show configuration xml vs TCP <name>
```

--------------------------------

### Upgrade Image with Backup Hash and UUID Modification

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/system-config/images-backups.html

Installs a new image from a `.tar.gz` archive, using a specified backup hash and modifying the device image unique identifier. This combines update and unique identification features.

```bash
vamgr upgrade --mod-uuid -s <backup_hash> <archive_path>
```

--------------------------------

### Python HTTP Health Check Script

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/script-healthcheck.html

This script performs an HTTP health check by sending HEAD and GET requests to a target IP and port. It requires a `config.py` file for configuration and uses the `requests` and `sys` modules. The script exits with status 1 if the check fails, and 0 if successful.

```python
import sys
import requests
import config # Импорт файла с классом Config

def check_http(target_ip, target_port):
    url = f"http://{target_ip}:{target_port}"
    try:
        response = requests.head(url, timeout=3)
        print("HEAD: OK")
        response = requests.get(url, timeout=3)
        print("GET: OK")
        return True
    except requests.exceptions.RequestException:
        print("NOT OK")
        return False

config = config.Config(sys.argv) # Использование класса
source_ip = config.source_ip # Получение source-ip
target_ip = config.target_ip # Получение target-ip
target_port = config.target_port # Получение target-port

print(f"Config:")
print(f"  Source IP: {source_ip}")
print(f"  Target IP: {target_ip}")
print(f"  Target Port: {target_port}")
print(f"Checking HTTP server at {target_ip}:{target_port}...", end=" ")

if not check_http(target_ip, target_port):
    sys.exit(1)

sys.exit(0)
```

--------------------------------

### Forming PKI URL for Certificate Retrieval

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/security/openbao.html

Demonstrates how to construct a PKI URL for retrieving specific certificate components (certificate, private key, or CA certificate) by appending fragments to the base URL and query parameters.

```bash
pki://pki/issue/example-dot-com?common_name="app.example.com"&ttl="24h"#certificate
```

```bash
pki://pki/issue/example-dot-com?common_name="app.example.com"&ttl="24h"#private_key
```

```bash
pki://pki/issue/example-dot-com?common_name="app.example.com"&ttl="24h"#issuing_ca
```

--------------------------------

### Specify Diffie-Hellman Parameters File

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/tls.html

Configure the Diffie-Hellman parameter file used for secure key exchange during SSL connection establishment. The full file name with extension must be specified.

```bash
set ssl-profile server <profile_name> host <name> setting dh-params <file_name>
```

--------------------------------

### View Server TCP Profile Configuration (TXT)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/profiles.html

View the configured server TCP profile settings in TXT format.

```bash
show configuration txt tcp-profile server <name>
```

--------------------------------

### Create Client HTTP Profile

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/profiles.html

Use this command to create a new Client HTTP Profile. A default profile 'httpp-client-default' exists and cannot be modified or deleted.

```bash
set http-profile client <name>
```

--------------------------------

### Apply and Save Configuration

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/tls.html

Applies the currently configured settings and saves them to the system's configuration. These commands are essential after making changes to SSL profiles.

```bash
commit
```

```bash
write
```

--------------------------------

### View Client TCP Profile Configuration (XML)

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/traffic-management/profiles.html

Display the configured client TCP profile settings in XML format.

```bash
show configuration xml tcp-profile client <name>
```

--------------------------------

### Create Virtual Server for HTTP Balancing

Source: https://termidesk.ru/docs/en-connect-doc/v1.3/documentation/settings/cli/set/object-vs.html

Creates a Virtual Server for HTTP load balancing.

```APIDOC
## set vs HTTP <name>

### Description
Creation of Virtual Server for HTTP balancing.
Configuration of Virtual Server for HTTP balancing.

### Method
APICALL

### Endpoint
set vs HTTP <name>
```