meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
domestic:rosplatforma:man:prlsrvctl [2023/01/26 09:22] – mchusdomestic:rosplatforma:man:prlsrvctl [2023/01/26 09:40] (current) – [Configuring R-Virtualization Server IP private networks] mchus
Line 11: Line 11:
 prlsrvctl **info** [**-j, --json**] [**--license**] [**-f, --full**] prlsrvctl **info** [**-j, --json**] [**--license**] [**-f, --full**]
  
-prlsrvctl **set** [-s,--min-security-level <//low//|//normal//|//high//>] [{--device <//device//> --assignment <//host//|//vm//>}] [--backup-storage **<user<nowiki>[[:</nowiki>passwd]@server[:port]]>**] [--backup-path <//path//>] [--idle-connection-timeout <//timeout//>] [--backup-tmpdir **tmpdir**] [--allow-attach-screenshots <//on//|//off//>] [--cpu-features-mask <{{//+//,//-//}//feature1//,//feature=value//}[//,//...]>] [--vm-cpulimit-type <//full//|//guest//>] [--vcmmd-policy <//density//|//performance//>] [--vnc-ssl-certificate <//fname//> --vnc-ssl-key <//fname//>] [**OPTIONS**]+prlsrvctl **set** [-s,--min-security-level <//low//|//normal//|//high//>] [{--device <//device//> --assignment <//host//|//vm//>}] [--backup-storage **<user<nowiki>[[:</nowiki>passwd]@server[:port]]>**] [--backup-path <//path//>] [--idle-connection-timeout <//timeout//>] [--backup-tmpdir **tmpdir**] [--allow-attach-screenshots <//on//|//off//>] [--cpu-features-mask <nowiki><{{//+//,//-//}//feature1//,//feature=value//}[//,//...]>]</nowiki> [--vm-cpulimit-type <//full//|//guest//>] [--vcmmd-policy <//density//|//performance//>] [--vnc-ssl-certificate <//fname//> --vnc-ssl-key <//fname//>] [**OPTIONS**]
  
 prlsrvctl **install-license -k,--key** <//key//> [**-n,--name <**//name//>] [**-c,--company** <//name//>] [**OPTIONS**] prlsrvctl **install-license -k,--key** <//key//> [**-n,--name <**//name//>] [**-c,--company** <//name//>] [**OPTIONS**]
Line 63: Line 63:
 ===== OPTIONS  ===== ===== OPTIONS  =====
  
-**Flags**\\ +==== Flags ====
-The following flags can be used with the majority of **prlsrvctl** commands.\\ +
--l,--login user<nowiki>[[:</nowiki>passwd]@server+
  
-Connect to the remote R-Virtualization server using the IP address or hostname of **server** and the specified credentials (i.e. the **user** username and **passwd** password). If no connection parameters are specified, **prlsrvctl** assumes that the command is run on the local server.+The following flags can be used with the majority of **prlsrvctl** commands. 
 +  * -l,--login user<nowiki>[[:</nowiki>passwd]@server - Connect to the remote R-Virtualization server using the IP address or hostname of **server** and the specified credentials (i.e. the **user** username and **passwd** password). If no connection parameters are specified, **prlsrvctl** assumes that the command is run on the local server. 
 +  * **--timeout <sec>** - Specify custom operation timeout in seconds (by default any operation has infinit timeout).
  
-**--timeout <sec>**+==== Configuring R-Virtualization Server parameters ====
  
-Specify custom operation timeout in seconds (by default any operation has infinit timeout). +**set** [**SET_OPTIONS**]
- +
-**Configuring R-Virtualization Server parameters\\ +
-set** [**SET_OPTIONS**]+
  
 This command is used to set and configure various VM parameters.\\ This command is used to set and configure various VM parameters.\\
 The following options can be used with the **set** command: The following options can be used with the **set** command:
  
-**-s,--min-security-level** <//low//|//normal//|//high//>+  * **-s,--min-security-level** <//low//|//normal//|//high//> - Specifies the minimum allowable security level that can be used by users to connect to the server:  
 +    * //low// - none of the transmitted data is encrypted.  
 +    * //normal// - only the most important data is encrypted.  
 +    * //high// - all transmitted data is encrypted. 
 +  * **--device** <//device//> --assignment <//host//|//vm//> - Set assignment mode for VTd devices.  
 +  * **--backup-path** <//path//> - Set the backup location on the local server. 
 +  * **--idle-connection-timeout** <//timeout//> - Sets a timeout interval in seconds after which, if no data has been received from the storage server or backup client, the process of backup/restore is terminated. 
 +  * **--backup-tmpdir** <**tmpdir**> - Set the backup directory for temporary snapshot creation. 
 +  * **--backup-storage <user<nowiki>[[:</nowiki>passwd]@server[:port]]>** - Set the default backup server. To unset, specify empty arguments. 
 +  * **--allow-attach-screenshots** <//on//|//off//> - Enables/disables attaching virtual machine and host screenshots to Problem Report. 
 +  * **--cpu-features-mask** <nowiki><{{</nowiki>//+//,//-//}//feature1//,//feature=value//}[//,//...]> - Changes host’s global CPU features mask. NOTE: All virtual machines and Containers on the host must be stopped. On/off (boolean) features can be masked and unmasked using the {//+//,//-//}//feature// syntax. Omitting the sign is equivalent to unmasking, e.g., the //+feature// syntax. Features which require specific values can be set using the //feature=value// syntax. For a list of host’s CPU features which are supported, maskable, and already masked, run the **prlsrvctl info --full** command. 
 +  * --vm-cpulimit-type <//full//|//guest//> - Specifies whether the CPU limit affects all virtual machine threads including service (//full//), or guest threads only (//guest//). 
 +  * **--vcmmd-policy** <//density//|//performance//> - Sets host’s global vcmmd policy. NOTE: Before setting the policy, stop all virtual machines and containers on the host or temporarily migrate them live to another host. 
 +  * **--vnc-ssl-certificate** <//fname//> **--vnc-ssl-key** <//fname//> = Install an SSL certificate and a private key to encrypt all VNC connections on node. To disable VNC encryption, specify empty arguments (e.g., ’’).
  
-Specifies the minimum allowable security level that can be used by users to connect to the server: //\\ +==== Managing R-Virtualization server ====
-low// - none of the transmitted data is encrypted. //\\ +
-normal// - only the most important data is encrypted. //\\ +
-high// - all transmitted data is encrypted.+
  
-**--device** <//device//> --assignment <//host//|//vm//>+  * **install-license -k,--key** <//key//> [**-n,--name <**//name//>] [**-c,--company** <//name//>] - Install R-Virtualization license. 
 +  * **update-license** - Update current R-Virtualization license. 
 +  * **info** - Show detailed information about the R-Virtualization server configuration. If the **--license** option is specified, only the license info is displayed. You can use the **--json** option to produce machine-readable output in JSON format. 
 +  * **problem-report** <**-d,--dump**|**-s,--send** [**--proxy** <//user[:password]@proxyhost[:port]//> | **--no-proxy**]> [**--stand-alone**] - Generate a problem report. If the **-s,--send** option is specified, the report will be sent to the report server. The **--stand-alone** option allows you to generate a report when the R-Virtualization Server service is not running.
  
-Set assignment mode for VTd devices.+==== Listing R-Virtualization server users ====
  
-**--backup-path** <//path//>+**user list** - Lists the R-Virtualization server users.
  
-Set the backup location on the local server.+==== Configuring user settings ==== 
 +**user set** - This command is used to manage the settings of the user currently logged in to the R-Virtualization server.
  
-**--idle-connection-timeout** <//timeout//>+You can use the following option with the command:  
 +  * **--def-vm-home** <//path//> - Set the default location on the R-Virtualization server for storing virtual machines of the current user.
  
-Sets a timeout interval in seconds after which, if no data has been received from the storage server or backup client, the process of backup/restore is terminated.+==== Configuring R-Virtualization Server Virtual Networks ====
  
-**--backup-tmpdir** <**tmpdir**>+**net** [**NET_OPTIONS**]
  
-Set the backup directory for temporary snapshot creation.+This command is used to manage Virtual Networks on the R-Virtualization server. //vnetwork_id// denotes the Virtual Network you want to configure.
  
-**--backup-storage <user<nowiki>[[:</nowiki>passwd]@server[:port]]>**+The following actions can be used with the **net** command:  
 +  * **add** Create a new Virtual Network.  
 +  * **set** Update the Virtual Network’s properties.  
 +  * **del** Remove the specified Virtual Network.  
 +  * **info** Show detailed information about the specified Virtual Network.  
 +  * **list** List the available Virtual Networks on the R-Virtualization server.
  
-Set the default backup server. To unset, specify empty arguments.+The following options can be used with the **net** actions:  
 +  * **-i,--ifname** <//if//> - Set the name of the network card on the R-Virtualization server to which the Virtual Network will be bound. 
 +  * **-m,--mac** <//mac//> - Set the MAC address of the network card on the R-Virtualization server to which the Virtual Network will be bound. The network card with the specified MAC address must exist on the R-Virtualization server. 
 +  * **-t,--type** <//bridged//|//host-only//> - Specifies the type of the Virtual Network.  
 +    * //bridged// A virtual machine connected to this type of Virtual Network appears as an independent computer on the network.  
 +    * //host-only// A virtual machine connected to this type of Virtual Network can access only the R-Virtualization server and the virtual machines connected to the same Virtual Network. 
 +  * **-d,--description** <//description//> - Set the Virtual Network description. 
 +  * **--ip** <//ip[/mask]//> - Set an IPv4 address and subnet mask for the R-Virtualization virtual adapter. 
 +  * **--dhcp-server** <//on//|//off//> - Enable or disable the R-Virtualization virtual DHCPv4 server. 
 +  * **--dhcp-ip** <//ip//> - Set an IPv4 address for the R-Virtualization virtual DHCPv4 server. 
 +  * **--ip-scope-start** <//ip//> - Set a start IPv4 address for the pool of IPv4 addresses. 
 +  * **--ip-scope-end** <//ip//> - Set an end IPv4 address for the pool of IPv4 addresses. 
 +  * **--ip6** <//ip[/mask]//> - Set an IPv6 address and subnet mask for the R-Virtualization virtual adapter. 
 +  * **--dhcp6-server** <//on//|//off//> - Enable or disable the R-Virtualization virtual DHCPv6 server. 
 +  * **--dhcp-ip6** <//ip//> - Set an IPv6 address for the R-Virtualization virtual DHCPv6 server. 
 +  * **--ip6-scope-start** <//ip//> - Set a start IPv6 address for the pool of IPv6 addresses. 
 +  * **--ip6-scope-end** <//ip//> - Set an end IPv6 address for the pool of IPv6 addresses.
  
-**--allow-attach-screenshots** <//on//|//off//>+==== Configuring R-Virtualization Server IP private networks ====
  
-Enables/disables attaching virtual machine and host screenshots to Problem Report. +**privnet** [**PRIVNET_OPTIONS**]
- +
-**--cpu-features-mask** <{{//+//,//-//}//feature1//,//feature=value//}[//,//...]> +
- +
-Changes host’s global CPU features mask. NOTE: All virtual machines and Containers on the host must be stopped. On/off (boolean) features can be masked and unmasked using the {//+//,//-//}//feature// syntax. Omitting the sign is equivalent to unmasking, e.g., the //+feature// syntax. Features which require specific values can be set using the //feature=value// syntax. For a list of host’s CPU features which are supported, maskable, and already masked, run the **prlsrvctl info --full** command. +
- +
---vm-cpulimit-type <//full//|//guest//> +
- +
-Specifies whether the CPU limit affects all virtual machine threads including service (//full//), or guest threads only (//guest//). +
- +
-**--vcmmd-policy** <//density//|//performance//> +
- +
-Sets host’s global vcmmd policy. NOTE: Before setting the policy, stop all virtual machines and containers on the host or temporarily migrate them live to another host. +
- +
-**--vnc-ssl-certificate** <//fname//> **--vnc-ssl-key** <//fname//> +
- +
-Install an SSL certificate and a private key to encrypt all VNC connections on node. To disable VNC encryption, specify empty arguments (e.g., ’’). +
- +
-**Managing R-Virtualization server\\ +
-install-license -k,--key** <//key//> [**-n,--name <**//name//>] [**-c,--company** <//name//>] +
- +
-Install R-Virtualization license. +
- +
-**update-license** +
- +
-Update current R-Virtualization license. +
- +
-**info** +
- +
-Show detailed information about the R-Virtualization server configuration. If the **--license** option is specified, only the license info is displayed. You can use the **--json** option to produce machine-readable output in JSON format. +
- +
-**problem-report** <**-d,--dump**|**-s,--send** [**--proxy**\\ +
-<//user[:password]@proxyhost[:port]//> | **--no-proxy**]> [**--stand-alone**] +
- +
-Generate a problem report. If the **-s,--send** option is specified, the report will be sent to the report server. The **--stand-alone** option allows you to generate a report when the R-Virtualization Server service is not running. +
- +
-**Listing R-Virtualization server users\\ +
-user list** +
- +
-Lists the R-Virtualization server users. +
- +
-**Configuring user settings\\ +
-user set** +
- +
-This command is used to manage the settings of the user currently logged in to the R-Virtualization server. +
- +
-You can use the following option with the command: **\\ +
---def-vm-home** <//path//> +
- +
-Set the default location on the R-Virtualization server for storing virtual machines of the current user. +
- +
-**Configuring R-Virtualization Server Virtual Networks\\ +
-net** [**NET_OPTIONS**] +
- +
-This command is used to manage Virtual Networks on the R-Virtualization server. //vnetwork_id// denotes the Virtual Network you want to configure.\\ +
-The following actions can be used with the **net** command: **\\ +
-add** Create a new Virtual Network. **\\ +
-set** Update the Virtual Network’s properties. **\\ +
-del** Remove the specified Virtual Network. **\\ +
-info** Show detailed information about the specified Virtual Network. **\\ +
-list** List the available Virtual Networks on the R-Virtualization server. +
- +
-The following options can be used with the **net** actions: **\\ +
--i,--ifname** <//if//> +
- +
-Set the name of the network card on the R-Virtualization server to which the Virtual Network will be bound. +
- +
-**-m,--mac** <//mac//> +
- +
-Set the MAC address of the network card on the R-Virtualization server to which the Virtual Network will be bound. The network card with the specified MAC address must exist on the R-Virtualization server. +
- +
-**-t,--type** <//bridged//|//host-only//> +
- +
-Specifies the type of the Virtual Network. //\\ +
-bridged// A virtual machine connected to this type of Virtual Network appears as an independent computer on the network. //\\ +
-host-only// A virtual machine connected to this type of Virtual Network can access only the R-Virtualization server and the virtual machines connected to the same Virtual Network. +
- +
-**-d,--description** <//description//> +
- +
-Set the Virtual Network description. +
- +
-**--ip** <//ip[/mask]//> +
- +
-Set an IPv4 address and subnet mask for the R-Virtualization virtual adapter. +
- +
-**--dhcp-server** <//on//|//off//> +
- +
-Enable or disable the R-Virtualization virtual DHCPv4 server. +
- +
-**--dhcp-ip** <//ip//> +
- +
-Set an IPv4 address for the R-Virtualization virtual DHCPv4 server. +
- +
-**--ip-scope-start** <//ip//> +
- +
-Set a start IPv4 address for the pool of IPv4 addresses. +
- +
-**--ip-scope-end** <//ip//> +
- +
-Set an end IPv4 address for the pool of IPv4 addresses. +
- +
-**--ip6** <//ip[/mask]//> +
- +
-Set an IPv6 address and subnet mask for the R-Virtualization virtual adapter. +
- +
-**--dhcp6-server** <//on//|//off//> +
- +
-Enable or disable the R-Virtualization virtual DHCPv6 server. +
- +
-**--dhcp-ip6** <//ip//> +
- +
-Set an IPv6 address for the R-Virtualization virtual DHCPv6 server. +
- +
-**--ip6-scope-start** <//ip//> +
- +
-Set a start IPv6 address for the pool of IPv6 addresses. +
- +
-**--ip6-scope-end** <//ip//> +
- +
-Set an end IPv6 address for the pool of IPv6 addresses. +
- +
-**Configuring R-Virtualization Server IP private networks\\ +
-privnet** [**PRIVNET_OPTIONS**]+
  
 This command is used to manage IP private networks on the R-Virtualization server. //private_network_id// denotes the IP private network you want to configure.\\ This command is used to manage IP private networks on the R-Virtualization server. //private_network_id// denotes the IP private network you want to configure.\\
-The following actions can be used with the **privnet** command: **\\ +The following actions can be used with the **privnet** command:  
-add** Create a new IP private network. **\\ +  * **add** Create a new IP private network.  
-set** Update the IP private network’s properties. **\\ +  * **set** Update the IP private network’s properties.  
-del** Remove the specified IP private network. **\\ +  * **del** Remove the specified IP private network.  
-list** List the available IP private networks on the R-Virtualization server. +  * **list** List the available IP private networks on the R-Virtualization server.
- +
-The following options can be used with the **privnet** command: **\\ +
--a,--ipadd** <//addr//> +
- +
-Add the IP subnet to the list of subnets in the specified IP private network. Specify an asterisk (’*’) to make the IP private network "weak" and allow its IP addresses to access all other IP addresses, excluding those in regular private networks. +
- +
-**-d,--ipdel** <//addr//> +
- +
-Remove the IP subnet from the list of subnets in the specified IP private network. +
- +
-**--global** <//yes//|//no//> +
- +
-Specify whether the IP subnet defines global range of the IP addresses to be treated as covered by some private network or just particular IP private network. +
- +
-**Configuring Automatic USB Device Assignments\\ +
-usb list** +
- +
-List the USB devices installed on the server together with the information on their assignments for the current user. +
- +
-**usb set** <//usb_dev_id//> <//vm_uuid// | //vm_name//> +
- +
-Assign the USB device with ID <//usb_dev_id//> to the virtual machine <//vm_uuid//>. This USB device will be connected to the specified virtual machine when you start the virtual machine or attach the device to the R-Virtualization server. +
- +
-**usb del** <//usb_dev_id//> +
- +
-Remove the assignment for the USB device with ID <//usb_dev_id//>. +
- +
-**Configuring templates for Containers\\ +
-cttemplate list** +
- +
-List the OS and application templates installed on the R-Virtualization server. +
- +
-**cttemplate remove** <//name//> [<//os_template_name//>] +
- +
-Remove the specified OS or application template from the R-Virtualization server. To delete an application template, you need to additionally indicate the //os_template_name// parameter. +
- +
-**cttemplate copy** <//dst_node//> <//name//> [<//os_template_name//>] [**-f,--force**] +
- +
-Copies the specified OS or application template from the local server to the destination server **dst_node**. To copy an application template, you need to additionally indicate the //os_template_name// parameter. The destination server must be specified in this format: [user[:password]@]server_IP_address_or_hostname[:port]. If the **--force** option is specified, all validation checks will be skipped. +
- +
-**plugin list**+
  
-List all installed R-Virtualization plugins.+The following options can be used with the **privnet** command:  
 +  * **-a,--ipadd** <//addr//> - Add the IP subnet to the list of subnets in the specified IP private network. Specify an asterisk (’*’) to make the IP private network "weak" and allow its IP addresses to access all other IP addresses, excluding those in regular private networks. 
 +  * **-d,--ipdel** <//addr//> - Remove the IP subnet from the list of subnets in the specified IP private network.  
 +  * **--global** <//yes//|//no//> - Specify whether the IP subnet defines global range of the IP addresses to be treated as covered by some private network or just particular IP private network.
  
-**plugin refresh**+==== Configuring Automatic USB Device Assignments ====
  
-Refresh installed R-Virtualization plugins.+**usb list** - List the USB devices installed on the server together with the information on their assignments for the current user.
  
-**Backup management\\ +**usb set** <//usb_dev_id//> <//vm_uuid// | //vm_name//> - Assign the USB device with ID <//usb_dev_id//> to the virtual machine <//vm_uuid//>. This USB device will be connected to the specified virtual machine when you start the virtual machine or attach the device to the R-Virtualization server.
-backup** [**-f,--full**] [**-i,--incremental**] [**-s,--storage**\\ +
-<//user[:password]@server[:port]//>] [**--description** <//desc//>]\\ +
-[**-u,--uncompressed**]+
  
-Back up all virtual environments on the node.+**usb del** <//usb_dev_id//> - Remove the assignment for the USB device with ID <//usb_dev_id//>.
  
-**-f,--full**+==== Configuring templates for Containers ====
  
-Create a full backup of each virtual environment on the node. A full backup contains all the virtual environment data.+**cttemplate list** - List the OS and application templates installed on the R-Virtualization server.
  
-**-i,--incremental**+**cttemplate remove** <//name//> [<//os_template_name//>] - Remove the specified OS or application template from the R-Virtualization server. To delete an application template, you need to additionally indicate the //os_template_name// parameter.
  
-Create an incremental backup of each virtual environment on the node. An incremental backup contains only the files that were changed since the previous full or incremental backup. This is the default backup type.+**cttemplate copy** <//dst_node//> <//name//> [<//os_template_name//>] [**-f,--force**] - Copies the specified OS or application template from the local server to the destination server **dst_node**. To copy an application template, you need to additionally indicate the //os_template_name// parameter. The destination server must be specified in this format: [user[:password]@]server_IP_address_or_hostname[:port]. If the **--force** option is specified, all validation checks will be skipped.
  
-**-s,--storage** <//user[:password]@server[:port]//>+**plugin list** - List all installed R-Virtualization plugins.
  
-Specify the host to store backup images at.+**plugin refresh** - Refresh installed R-Virtualization plugins.
  
-**--description** <//desc//>+==== Backup management ====
  
-Add a description //desc// to each virtual environment backup. 
  
-**-u,--uncompressed**+**backup** [**-f,--full**] [**-i,--incremental**] [**-s,--storage** <//user[:password]@server[:port]//>] [**--description** <//desc//>] [**-u,--uncompressed**] - Back up all virtual environments on the node.
  
-Do not compress backup images.+  * **-f,--full** - Create a full backup of each virtual environment on the node. A full backup contains all the virtual environment data. 
 +  * **-i,--incremental** - Create an incremental backup of each virtual environment on the node. An incremental backup contains only the files that were changed since the previous full or incremental backup. This is the default backup type. 
 +  * **-s,--storage** <//user[:password]@server[:port]//> - Specify the host to store backup images at. 
 +  * **--description** <//desc//> - Add a description //desc// to each virtual environment backup. 
 +  * **-u,--uncompressed** - Do not compress backup images.
  
-**Traffic control management\\ +==== Traffic control management ====
-tc restart**+
  
-Apply the traffic shaping setting to all running virtual environments.+**tc restart** - Apply the traffic shaping setting to all running virtual environments.
  
 ===== DIAGNOSTICS  ===== ===== DIAGNOSTICS  =====
Line 324: Line 196:
 ===== SEE ALSO  ===== ===== SEE ALSO  =====
  
-**prlctl**(8)+**[[domestic:rosplatforma:man:prlctl]]**(8)
  
 ===== COPYRIGHT  ===== ===== COPYRIGHT  =====