| getiptunnelResult Structure Definition |
The getiptunnelResult structure defines the return type for getiptunnel API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
iptunnelList |
List of iptunnels |
| iptunnel Structure Definition |
The iptunnel structure defines the actual return type values for getiptunnel API. |
Syntax |
Members |
remote |
Public IPv4 address, of the remote device, used to set up the tunnel. |
remotesubnetmask |
Subnet mask of the remote IP address of the tunnel. |
name |
Name for the IP tunnel. |
name2 |
The name of the ip tunnel. |
local |
Type of Citrix ADC owned public IPv4 address, configured on the local Citrix ADC and used to set up the tunnel. |
protocol |
Name of the protocol to be used on this tunnel. |
grepayload |
The payload GRE will carry |
type |
The type of this tunnel. |
encapip |
The effective local IP address of the tunnel. Used as the source of the encapsulated packets. |
channel |
The tunnel that is bound to a netbridge. |
ipsecprofilename |
Name of IPSec profile to be associated. |
vlan |
The vlan for mulicast packets |
tunneltype |
Indicates that a tunnel is User-Configured, Internal or DELETE-IN-PROGRESS. |
ipsectunnelstatus |
Whether the ipsec on this tunnel is up or down. |
ownergroup |
The owner node group in a Cluster for the iptunnel. |
refcnt |
Number of PBRs to bound to this iptunnel |
vnid |
Virtual network identifier (VNID) is the value that identifies a specific virtual network in the data plane. |
vlantagging |
Option to select Vlan Tagging. |
destport |
Specifies UDP destination port for Geneve packets. Default port is 6081. |
tosinherit |
Default behavior is to copy the ToS field of the internal IP Packet (Payload) to the outer IP packet (Transport packet). But the user can configure a new ToS field using this option. |
_nextgenapiresource |
See Also |