Package prlsdkapi :: Class DispConfig
[hide private]
[frames] | no frames]

Class DispConfig

  object --+            
           |            
 prlsdk.Base --+        
               |        
prlsdk.BaseAsync --+    
                   |    
prlsdk.OwnerRefAsync --+
                       |
                      DispConfig

The DispConfig class provides methods for managing Parallels Service preferences.

Instance Methods [hide private]
 
commit(self)
Commit the changes to the Parallels Service.
 
create_net_adapter(self)
Create and return a new virtual network adapter object and add it to the network adapter list.
 
get_net_adapter(self, index)
Return information about the specified virtual network adapter.
 
remove_net_adapter(self, net_adapter)
Remove the specified virtual network adapter object from the adapter list.

Inherited from prlsdk.OwnerRefAsync: __init__, __new__

Inherited from prlsdk.BaseAsync: __cmp__, __repr__, cancel, wait

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __str__

Class Variables [hide private]
  __prefix__ = 'dispcfg'
  __ht__ = 268435478
Properties [hide private]
  auto_mem_adjust
Specifies whether the size of the memory allocated to the Parallels Service will be set automatically or manually.
  default_vm_dir
Name and path of the default virtual machine folder.
  reserved_mem_limit
Specifies the memory size reserved for the Parallels Service operations
  net_adapters_count
The total number of the available netwrok adapters.
  default_vnc_host_name
The default VNC host name of this Parallels Service.
  vnc_base_port
The base VNC port number.
  can_change_default_settings
Indicates whether new users are by default allowed to modify the Parallels Service preferences.
  min_security_level
Indicates the lowest allowable security level that can be used to connect to this Parallels Service.
  net_adapters
An iterator/sequence that allows to traverse through network adapter collection.

Inherited from prlsdk.OwnerRefAsync: __owner__

Inherited from prlsdk.BaseAsync: __expected_h_type__, __job__, finished, handle_type

Inherited from prlsdk.Base: __handle__

Inherited from object: __class__

Method Details [hide private]

commit(self)

 

Commit the changes to the Parallels Service.

Before making any changes to Parallels Service preferences, call Server.begin_edit_common_prefs to timestamp the beginning of the operation. When you are done making the changes, call this method to commit the changes to the Parallels Service. This is an asynchronous method.

Returns:
A Job object.

create_net_adapter(self)

 

Create and return a new virtual network adapter object and add it to the network adapter list.

Returns:
A new DispNet instance.

get_net_adapter(self, index)

 

Return information about the specified virtual network adapter.

Parameters:
  • index - The index specifying the net adapter in the adapter list. To obtain the total number of the available adapters, examine the DispConfig.net_adapters_count property.
Returns:
A DispNet object containing the specified virtual network adapter information.

remove_net_adapter(self, net_adapter)

 

Remove the specified virtual network adapter object from the adapter list.

Parameters:
  • net_adapter - Identifies the network adapter. This could be a DispNet object or the adapter's index in the list. This is an asynchronous method.
Returns:
A Job object.

Property Details [hide private]

auto_mem_adjust

Specifies whether the size of the memory allocated to the Parallels Service will be set automatically or manually.

Get Method:
unreachable.dispcfg__get_auto_mem_adjust(SDK, DispConfig) - Returns sign whether system must auto adjusting VMs memory size.
Set Method:
unreachable.dispcfg__set_auto_mem_adjust(SDK, DispConfig, value) - Sets auto adjusting VMs memory size flag.

default_vm_dir

Name and path of the default virtual machine folder.

Get Method:
unreachable.dispcfg__get_default_vm_dir(SDK, DispConfig) - Returns default VM directory.

reserved_mem_limit

Specifies the memory size reserved for the Parallels Service operations

Get Method:
unreachable.dispcfg__get_reserved_mem_limit(SDK, DispConfig) - Returns common reserved for VMs memory limit in megabytes.
Set Method:
unreachable.dispcfg__set_reserved_mem_limit(SDK, DispConfig, value) - Sets common reserved for VMs memory limit in megabytes.

net_adapters_count

The total number of the available netwrok adapters.

Get Method:
unreachable.dispcfg__get_net_adapters_count(SDK, DispConfig) - Returns net adapters count.

default_vnc_host_name

The default VNC host name of this Parallels Service.

Get Method:
unreachable.dispcfg__get_default_vnc_host_name(dispcfg, DispCfg) - Returns base remote display host name
Set Method:
unreachable.dispcfg__set_default_vnc_host_name(dispcfg, DispCfg, new_base_host_name) - Sets base remote display host name

vnc_base_port

The base VNC port number.

Get Method:
unreachable.dispcfg__get_vnc_base_port(dispcfg, DispCfg) - Returns base remote display port number
Set Method:
unreachable.dispcfg__set_vnc_base_port(dispcfg, DispCfg, base_port_number) - Sets base remote display port number

can_change_default_settings

Indicates whether new users are by default allowed to modify the Parallels Service preferences. True - can modify; False - cannot modify.

Get Method:
unreachable.dispcfg__get_can_change_default_settings(dispcfg, DispCfg) - Returns sign whether a new user can change the common server parameters
Set Method:
unreachable.dispcfg__set_can_change_default_settings(dispcfg, DispCfg, value) - Sets sign whether a new user can change the common server parameters

min_security_level

Indicates the lowest allowable security level that can be used to connect to this Parallels Service. See consts.PSL_xxx for available security levels.

Get Method:
unreachable.dispcfg__get_min_security_level(dispcfg, DispCfg) - Returns minimal security level for connection with server, see prlsdk.consts.PSL_xxx
Set Method:
unreachable.dispcfg__set_min_security_level(dispcfg, DispCfg, level) - Sets minimal security level (see prlsdk.consts.PSL_xxx) for connection with server

net_adapters

An iterator/sequence that allows to traverse through network adapter collection. Each network adapter is an instance of DispNet.

Get Method:
unreachable(s)