Changeset 27857 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl
- Timestamp:
- Mar 31, 2010 9:02:32 AM (15 years ago)
- File:
-
- 1 edited
-
trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/idl/VirtualBox.xidl
r27822 r27857 11598 11598 </attribute> 11599 11599 11600 <attribute name="natDriver" type="INATEngine" readonly="yes"> 11601 <desc> 11602 Instance of INATEngine allowing NAT network configuration. Active only when 11603 attach to NAT is happend. 11604 </desc> 11605 </attribute> 11606 11600 11607 <method name="attachToNAT"> 11601 11608 <desc> … … 13959 13966 </interface> 13960 13967 13968 <enum 13969 name="NATProtocol" 13970 uuid="e90164be-eb03-11de-94af-fff9b1c1b19f" 13971 > 13972 <desc>Protocols definitions are used for registering port-forward rules.</desc> 13973 <const name="UDP" value="0"> 13974 <desc>port-forwarding uses UDP protocol.</desc> 13975 </const> 13976 <const name="TCP" value="1"> 13977 <desc>port-forwarding uses TCP protocol.</desc> 13978 </const> 13979 </enum> 13980 13981 <interface 13982 name="INATEngine" extends="$unknown" 13983 uuid="4b286616-eb03-11de-b0fb-1701eca42246" 13984 wsmap="managed" 13985 > 13986 <desc>Interface for managing NAT engine: changing attributes and port-forwarding rules.</desc> 13987 <attribute name="network" type="wstring"> 13988 <desc>Defines network attribute of NAT engine (the same value used with built-in dhcp server to fill corresponding fields of DHCP leases).</desc> 13989 </attribute> 13990 <attribute name="hostIP" type="wstring"> 13991 <desc>IP of host interface where to bind all opened sockets 13992 <note> 13993 Note: it doesn't change binding of port forwarding. 13994 </note> 13995 </desc> 13996 </attribute> 13997 <attribute name="tftpPrefix" type="wstring"> 13998 <desc>TFTP prefix attribute which used with built-in DHCP server to fill corresponding fields of DHCP leases.</desc> 13999 </attribute> 14000 <attribute name="tftpBootFile" type="wstring"> 14001 <desc>TFTP boot file attribute which used with built-in DHCP server to fill corresponding fields of DHCP leases.</desc> 14002 </attribute> 14003 <attribute name="tftpNextServer" type="wstring"> 14004 <desc>TFTP server attribute which used with built-in DHCP server to fill corresponding fields of DHCP leases. 14005 <note> 14006 Note: prefered form is IPv4 address. 14007 </note> 14008 </desc> 14009 </attribute> 14010 <attribute name="dnsPassDomain" type="boolean"> 14011 <desc>Attribute controls DHCP server behavior to pass or not DNS domain used by host.</desc> 14012 </attribute> 14013 <attribute name="dnsProxy" type="boolean"> 14014 <desc>Attribute controls DHCP server behavior and handling DNS traffic by NAT: to pass or not address of DNS proxy and process traffic using 14015 DNS servers registerd on host.</desc> 14016 </attribute> 14017 <attribute name="dnsUseHostResolver" type="boolean"> 14018 <desc>Attribute controls DHCP server behavior and handling DNS traffic by NAT: to pass or not address of DNS proxy and process traffic using 14019 host resolver mechanism.</desc> 14020 </attribute> 14021 <attribute name="redirects" type="wstring" readonly="yes" safearray="yes"> 14022 <desc>Array of port-forwarding rules in string representaion of following format: "name,protocol id,host ip,host port,guest ip,guest port".</desc> 14023 </attribute> 14024 <method name="setNetworkSettings"> 14025 <desc>Sets network configuration of NAT engine.</desc> 14026 <param name="mtu" type="unsigned long" dir="in"> 14027 <desc>Sets MTU of NAT engine.</desc> 14028 </param> 14029 <param name="sockSnd" type="unsigned long" dir="in"> 14030 <desc>Sets capacity of send buffer of socket used while creating new socket.</desc> 14031 </param> 14032 <param name="sockRcv" type="unsigned long" dir="in"> 14033 <desc>Sets capacity of receive buffer of socket used while creating new socket.</desc> 14034 </param> 14035 <param name="TcpWndSnd" type="unsigned long" dir="in"> 14036 <desc>Sets initial size of sending tcp window used with NAT engine while establishing new TCP connection.</desc> 14037 </param> 14038 <param name="TcpWndRcv" type="unsigned long" dir="in"> 14039 <desc>Sets initial size of receiving tcp window used with NAT engine while establishing new TCP connection.</desc> 14040 </param> 14041 </method> 14042 <method name="getNetworkSettings"> 14043 <desc>Returns network configuration of NAT engine.</desc> 14044 <param name="mtu" type="unsigned long" dir="out"> 14045 <desc>Returns MTU of NAT engine.</desc> 14046 </param> 14047 <param name="sockSnd" type="unsigned long" dir="out"> 14048 <desc>Returns capacity of send buffer of socket used while creating new socket.</desc> 14049 </param> 14050 <param name="sockRcv" type="unsigned long" dir="out"> 14051 <desc>Returns capacity of receive buffer of socket used while creating new socket.</desc> 14052 </param> 14053 <param name="TcpWndSnd" type="unsigned long" dir="out"> 14054 <desc>Returns initial size of sending tcp window used with NAT engine while establishing new TCP connection.</desc> 14055 </param> 14056 <param name="TcpWndRcv" type="unsigned long" dir="out"> 14057 <desc>Returns initial size of receiving tcp window used with NAT engine while establishing new TCP connection.</desc> 14058 </param> 14059 </method> 14060 <method name="addRedirect"> 14061 <desc>Adds port-forwarding rule.</desc> 14062 <param name="name" type="wstring" dir="in"> 14063 <desc>Name of the rule. 14064 <note>Empty name is acceptable. In case of empty name NAT engine generates new name using rest of parameters.</note> 14065 </desc> 14066 </param> 14067 <param name="proto" type="NATProtocol" dir="in"> 14068 <desc>Protocol handled with rule.</desc> 14069 </param> 14070 <param name="hostIp" type="wstring" dir="in"> 14071 <desc>IP of host interface which handled handled with rule. 14072 <note> 14073 Empty ip address is acceptable. In case of empty address NAT engine binds handling socket to any interface. 14074 </note> 14075 </desc> 14076 </param> 14077 <param name="hostPort" type="unsigned short" dir="in"> 14078 <desc>Port number to listen on.</desc> 14079 </param> 14080 <param name="guestIp" type="wstring" dir="in"> 14081 <desc>IP address of the guest where NAT engine will forward packets which have met rule requirement. 14082 <note> 14083 Empty IP address is acceptable. In case of empty IP NAT engine will forward packets to the first DHCP lease (x.x.x.15). 14084 </note> 14085 </desc> 14086 </param> 14087 <param name="guestPort" type="unsigned short" dir="in"> 14088 <desc>Port number to forward.</desc> 14089 </param> 14090 </method> 14091 <method name="removeRedirect"> 14092 <desc>Removes registered port forwarding.</desc> 14093 <param name="name" type="wstring" dir="in"> 14094 <desc>Name of the rule to delete.</desc> 14095 </param> 14096 </method> 14097 </interface> 14098 13961 14099 <module name="VBoxSVC" context="LocalServer"> 13962 14100 <class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
Note:
See TracChangeset
for help on using the changeset viewer.
