Virtual private servers (vds)

vds

Result: list of items

Virtual dedicated servers

Access level: admin user

Parameter	Value
`domain`	Domain name.
`ip`	IP address.
`ostempl`	OS template.
`processingnode`	Cluster node.
`serverid`	Name.
`id`	id.
`pricelist`	Tariff.
`account`	Client.
`project`	Provider.
`datacentername`	Data center.
`processingmodule`	Processing module.
`createdate`	Creation date.
`expiredate`	Expires on.
`autoprolong`	Auto-renewal.
`status_msg`	Description of the current VM state.
`item_status`	Service status. Possible values: 1 — ordered; 2 — active; 3 — suspended; 4 — deleted; 5 — processing.
`cost`	Cost.

Delete selected services

Function: vds.delete

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the vds function.

Result: successful operation or error message.

Log in to the panel with user privileges

Function: vds.su

Access level: admin

Set filter

Function: vds.filter

Suspend

Function: vds.suspend

Access level: admin

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the vds function.

Result: successful operation or error message.

Force stop

Function: vds.suspend.confirm

Access level: admin user

Parameters:

sok — parameter value must be non-empty, usually ok;
elid — unique identifier (id element from the vds function);
force — force stop flag. Possible values: on, off.

Result: successful operation or error message.

Resume

Function: vds.resume

Access level: admin

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the vds function.

Result: successful operation or error message.

Reboot

Function: vds.reboot.confirm

Access level: admin user

Parameters:

sok — parameter value must be non-empty, usually ok;
elid — unique identifier (id element from the vds function);
force — force stop flag. Possible values: on, off.

Create a ticket to move a Virtual server to VDC

Function: vds.movetovdc

Access level: user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the vds function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify object

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the vds function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

vdc — Virtual data center. Select the virtual data center to which virtual servers will be moved.

Order a new service

Function: vds.order

Access level: user

Set client filter

Function: vds.setfilter

Access level: admin

Edit properties of the selected service

Function: vds.edit

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the vds function);
Result: list of object parameters.

Create an object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify an object:

Parameters:
- panelid — control panel identifier;
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the vds function).
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`change_disc_size`	To enable this option, use the value `on`. Confirms that all required operations (stopping the virtual server, changing disk size, starting the virtual server) have been performed. Optional parameter.
`processingmodule`	Processing module.
`autoprolong`	Automatic renewal. Select the period for which the service will be automatically renewed upon expiration.
`createdate`	Service order date.
`opendate`	Activation date. The actual start date of the service.
`expiredate`	Expires on. Service validity period.
`scheduledclose`	To enable this option, use the value `on`. Scheduled deletion at the end of the paid period. Optional parameter.
`reboot`	To enable this option, use the value `on`. Optional parameter.
`note`	Service comment, visible only to provider staff.
`noexpense`	To enable this option, use the value `on`. Enable this option if no funds should be charged or refunded for the current resource modification operation. Optional parameter.
`comment`	Arbitrary text comment. Optional parameter.

Open a new service

Function: vds.open

Access level: admin

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the vds function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the vds function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`processingmodule`	Processing module assigned to the service.

Advanced settings

Rescue mode

Function: vds.systemrescue

Access level: admin user

Used to manage rescue mode transitions.

Toggle state:

Parameters:
- elid — unique identifier (id element from the vds function);
- sok — parameter value must be non-empty, usually ok;
- rescue_mode — rescue mode flag:
  - on — enter rescue mode;
  - off — exit rescue mode;
Result: successful operation or error message.

VM protection settings

Function: vds.protect

Access level: admin

Used to manage VM protection settings against deletion and modifications.

Toggle state:

Parameters:
- forbid_delete — deletion prohibition flag. Possible values: on, off;
- forbid_basic_action — basic VM actions prohibition flag. Possible values: on, off;
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the vds function);
Result: successful operation or error message.

Cloning

Function: service.clone

Access level: admin

Clones an active service, creating another service with identical settings (manual post-processing may be required).

Create clone:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier of the service to be cloned;
Result: successful operation or error message.

Password change

Function: service.changepassword

Access level: admin

Used to change the service password.

Change:

Parameters:
- elid — unique identifier (id element from the vds function);
- sok — parameter value must be non-empty, usually ok;
- passwd — new password containing only ASCII characters;
- confirm — new password confirmation (must match passwd);
Result: successful operation or error message.