7.3.4. Standalone server management
7.3.4.1. Standalone server connection methods
7.3.4.1.1. General information
As mentioned above, you can specify standalone server parameters using the configuration file or startup command line. You can specify a certain standalone server instance using the following methods:
- The --data command-line parameter of the ibcmd utility. In this case, the management utility performs actions with the infobase that is described by the data directory specified in the --data parameter. This management mode can be referred to as offline mode since you do not need a standalone server instance to execute commands. If a standalone server instance runs with a data directory, offline management mode is unavailable.
- The --pid command-line parameters of the ibcmd management utility. In this case, the management utility connects to a standalone server instance running on the same computer as the ibcmd utility. The --pid parameter value is an operating system process number of the running standalone server instance. The process number is specified in values of the operating system where the standalone server is running.
For example: --pid 16453.
- The --remote command-line parameters of the ibcmd management utility. In this case, the management utility connects to a standalone server instance running on a remote computer. The standalone server running on a remote computer must be configured so that it provides access to the infobase and the server over SSH protocol. The standalone server instance is identified using a URL and a port that hosts the standalone server.
For example: ssh://server1C:8282.
You do not need to specify the --data parameter or other parameters describing the infobase access parameters if a "remote" server is administered. The standalone server already contains all the required information. It is specified in the configuration file or ibsrv startup command-line parameters. Any instance of the standalone server started using the --pid or --remote parameters is considered "remote" in this case.
Not all management utility commands are available for a "remote" standalone server. Unavailable commands are listed below in the respective sections.
When you use the standalone server, an infobase session is created to perform commands that use access to the infobase. The user on whose behalf the session is created must have access rights to perform an action that is initiated by the command to be performed. If a command sent to the standalone server does not require access to the infobase but requires full access to the server (for example, to receive the session list), this command must be performed on behalf of the user with administration rights in the infobase that is serviced by this standalone server instance. Authentication is performed either interactively or using command-line options:
- Specify a username: --user.
- Specify a user password: --password.
The standalone server is administered with a restriction. If a directory is specified as a data directory of the running standalone server instance (the --data parameter), this directory cannot be used in the following cases:
- When starting another standalone server instance.
- When the administration utility operates in offline mode.
The order of session creation and authentication:
- If access is provided via a remote connection (SSH), a session is created on behalf of the user who is authenticated in SSH gateway.
- If access is provided via a local connection (a standalone server instance is selected on a local computer) or a configuration file is being configured, a session is created on behalf of 1C:Enterprise user with full administration rights.
7.3.4.1.2. Offline mode
The standalone server can perform all management utility commands. It can operate only on the same computer as the infobase data directory. The standalone server and the management utility cannot use the same infobase data directory (the --data parameter).
7.3.4.1.3. Connecting to a standalone server instance on a local computer
When you manage the standalone server using the management utility, you can use all the utility commands, except for the ones used to:
- Initialize the standalone server configuration (all config commands).
- Create an infobase (the ibcmd infobase create command).
- Restore infobase integrity (the ibcmd infobase repair command).
7.3.4.1.4. Connecting to a standalone server instance over SSH protocol
When you manage the standalone server using the management utility, you can use all the utility commands, except for the ones used to:
- Initialize the standalone server configuration (all config commands).
- Create an infobase (the ibcmd infobase create command).
- Restore infobase integrity (the ibcmd infobase repair command).
When SSH support is enabled for the standalone server, it can act not only as a server, but also as Designer running in the agent mode. In this mode, you can connect to the standalone server (except the ibcmd utility) using third-party SSH and SFTP clients and perform certain commands. Commands that you can perform using SSH client are similar to Designer commands in agent mode but only the following commands are supported:
- help. Display help information for commands.
- common. Common commands.
- connect-ib. Connect to an infobase.
- disconnect-ib. Disconnect from an infobase.
- options. Configure the current session.
- get. Get a parameter value.
- list. Get a parameter list.
- set. Set a parameter value.
- config. Configuration editing commands.
- dump-cfg. Save a configuration to a file.
- dump-config-to-files. Dump a configuration to XML files.
- dump-external-data-processor-or-report-to-files. Dump an external data processor/report to XML files.
- extensions. Operate with configuration extensions.
- generation-id. Get a generation ID for metadata.
- load-cfg. Load a configuration from a file.
- load-config-from-files. Load a configuration from XML files.
- load-external-data-processor-or-report-to-files. Load an external data processor/report from XML files.
- manage-cfg-support. Disable configuration support.
- mobile-app-write-file. Save a mobile application configuration to a hard drive.
- mobile-client-digi-sign. Generate a digital signature for the mobile client configuration.
- mobile-client-write-file. Save a mobile client configuration to a hard drive.
- sign-cfg. Digitally sign a configuration.
- update-db-cfg. Update a database configuration.
- infobase-tools. Get service information about an infobase.
- data-separation-common-attributes-list. Get a list of common attribute names.
- debug-info. Get information about the debugger.
- dump-ib. Dump an infobase to a file.
- erase-data. Delete infobase data.
- restore-ib. Restore a configuration from a file.
Files and directories created using SFTP are placed in the user data directory.
See also:
- Designer in agent mode
7.3.4.2. Available standalone server features
You can manage the availability of standalone server features. To do it, use special startup command line parameters or parameters of the features section of the configuration file. You can manage the following features:
- A gateway for direct connection to a standalone sever over TCP/IP. If the gateway is disabled, you cannot connect with the thick client or, in general, any client application that connects over TCP/IP. Debugging over TCP/IP also becomes unavailable.
- Enable the gateway: --enable-direct-gate or the direct-gate: true parameter of the features section in the configuration file of a standalone server.
- Disable the gateway: --disable-direct-gate or the direct-gate: false parameter of the features section in the configuration file of a standalone server.
- By default, the gateway is enabled.
- A gateway for connection to a standalone server over HTTP. If this gateway is disabled, connection over HTTP becomes unavailable for all client applications, including web client, mobile client, and other. Debugging over HTTP also becomes unavailable.
- Enable the gateway: --enable-http-gate or the http-gate: true parameter of the features section in the configuration file of a standalone server.
- Disable the gateway: --disable-http-gate or the http-gate: false parameter of the features section in the configuration file of a standalone server.
- By default, the gateway is enabled.
- A gateway for connection to the infobase over SSH protocol. Besides, you can execute commands using these protocols.
- Enable the gateway: --enable-ssh-gate or the ssh-gate: true parameter of the features section in the configuration file of a standalone server.
- Disable the gateway: --disable-ssh-gate or the ssh-gate: false parameter of the features section in the configuration file of a standalone server.
- By default, the gateway is enabled.
- Availability of extended Designer functionality. If it is disabled, you cannot use some standalone server capabilities, for example, save configurations for mobile devices to a file.
- Enable the gateway: --enable-extended-designer-features or the extended-designer-features: true parameter of the features section in the configuration file of a standalone server.
- Disable the gateway: --disable-extended-designer-features or the extended-designer-features: false parameter of the features section in the configuration file of a standalone server.
- By default, the gateway is enabled.
See also:
- Standalone server gateways
- Managing standalone server capabilities