1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. TrafficForwardingGreTunnel
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.TrafficForwardingGreTunnel

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia_traffic_forwarding_gre_tunnel resource manages GRE (Generic Routing Encapsulation) tunnels for traffic forwarding in the Zscaler Internet Access (ZIA) cloud service. GRE tunnels are used to forward traffic from on-premises networks to the Zscaler cloud.

    For more information, see the ZIA Traffic Forwarding documentation.

    Example Usage

    Basic GRE Tunnel

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.TrafficForwardingGreTunnel("example", {
    sourceIp: "203.0.113.10",
    comment: "Branch office GRE tunnel",
    withinCountry: true,
    ipUnnumbered: true,
});

    import zscaler_pulumi_zia as zia

example = zia.TrafficForwardingGreTunnel("example",
    source_ip="203.0.113.10",
    comment="Branch office GRE tunnel",
    within_country=True,
    ip_unnumbered=True,
)

    resources:
  example:
    type: zia:TrafficForwardingGreTunnel
    properties:
      sourceIp: "203.0.113.10"
      comment: Branch office GRE tunnel
      withinCountry: true
      ipUnnumbered: true

    Create TrafficForwardingGreTunnel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TrafficForwardingGreTunnel(name: string, args: TrafficForwardingGreTunnelArgs, opts?: CustomResourceOptions);
    @overload
def TrafficForwardingGreTunnel(resource_name: str,
                               args: TrafficForwardingGreTunnelArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def TrafficForwardingGreTunnel(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               source_ip: Optional[str] = None,
                               comment: Optional[str] = None,
                               country_code: Optional[str] = None,
                               internal_ip_range: Optional[str] = None,
                               ip_unnumbered: Optional[bool] = None,
                               primary_dest_vip: Optional[GreTunnelDestVipInputArgs] = None,
                               secondary_dest_vip: Optional[GreTunnelDestVipInputArgs] = None,
                               within_country: Optional[bool] = None)
    func NewTrafficForwardingGreTunnel(ctx *Context, name string, args TrafficForwardingGreTunnelArgs, opts ...ResourceOption) (*TrafficForwardingGreTunnel, error)
    public TrafficForwardingGreTunnel(string name, TrafficForwardingGreTunnelArgs args, CustomResourceOptions? opts = null)
    public TrafficForwardingGreTunnel(String name, TrafficForwardingGreTunnelArgs args)
public TrafficForwardingGreTunnel(String name, TrafficForwardingGreTunnelArgs args, CustomResourceOptions options)

    type: zia:TrafficForwardingGreTunnel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TrafficForwardingGreTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TrafficForwardingGreTunnelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TrafficForwardingGreTunnelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TrafficForwardingGreTunnelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TrafficForwardingGreTunnelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var trafficForwardingGreTunnelResource = new Zia.TrafficForwardingGreTunnel("trafficForwardingGreTunnelResource", new()
{
    SourceIp = "string",
    Comment = "string",
    CountryCode = "string",
    InternalIpRange = "string",
    IpUnnumbered = false,
    PrimaryDestVip = new Zia.Inputs.GreTunnelDestVipInputArgs
    {
        Datacenter = "string",
        Id = 0,
        VirtualIp = "string",
    },
    SecondaryDestVip = new Zia.Inputs.GreTunnelDestVipInputArgs
    {
        Datacenter = "string",
        Id = 0,
        VirtualIp = "string",
    },
    WithinCountry = false,
});

    example, err := zia.NewTrafficForwardingGreTunnel(ctx, "trafficForwardingGreTunnelResource", &zia.TrafficForwardingGreTunnelArgs{
	SourceIp:        pulumi.String("string"),
	Comment:         pulumi.String("string"),
	CountryCode:     pulumi.String("string"),
	InternalIpRange: pulumi.String("string"),
	IpUnnumbered:    pulumi.Bool(false),
	PrimaryDestVip: &pulumizia.GreTunnelDestVipInputArgs{
		Datacenter: pulumi.String("string"),
		Id:         pulumi.Int(0),
		VirtualIp:  pulumi.String("string"),
	},
	SecondaryDestVip: &pulumizia.GreTunnelDestVipInputArgs{
		Datacenter: pulumi.String("string"),
		Id:         pulumi.Int(0),
		VirtualIp:  pulumi.String("string"),
	},
	WithinCountry: pulumi.Bool(false),
})

    var trafficForwardingGreTunnelResource = new TrafficForwardingGreTunnel("trafficForwardingGreTunnelResource", TrafficForwardingGreTunnelArgs.builder()
    .sourceIp("string")
    .comment("string")
    .countryCode("string")
    .internalIpRange("string")
    .ipUnnumbered(false)
    .primaryDestVip(GreTunnelDestVipInputArgs.builder()
        .datacenter("string")
        .id(0)
        .virtualIp("string")
        .build())
    .secondaryDestVip(GreTunnelDestVipInputArgs.builder()
        .datacenter("string")
        .id(0)
        .virtualIp("string")
        .build())
    .withinCountry(false)
    .build());

    traffic_forwarding_gre_tunnel_resource = zia.TrafficForwardingGreTunnel("trafficForwardingGreTunnelResource",
    source_ip="string",
    comment="string",
    country_code="string",
    internal_ip_range="string",
    ip_unnumbered=False,
    primary_dest_vip={
        "datacenter": "string",
        "id": 0,
        "virtual_ip": "string",
    },
    secondary_dest_vip={
        "datacenter": "string",
        "id": 0,
        "virtual_ip": "string",
    },
    within_country=False)

    const trafficForwardingGreTunnelResource = new zia.TrafficForwardingGreTunnel("trafficForwardingGreTunnelResource", {
    sourceIp: "string",
    comment: "string",
    countryCode: "string",
    internalIpRange: "string",
    ipUnnumbered: false,
    primaryDestVip: {
        datacenter: "string",
        id: 0,
        virtualIp: "string",
    },
    secondaryDestVip: {
        datacenter: "string",
        id: 0,
        virtualIp: "string",
    },
    withinCountry: false,
});

    type: zia:TrafficForwardingGreTunnel
properties:
    comment: string
    countryCode: string
    internalIpRange: string
    ipUnnumbered: false
    primaryDestVip:
        datacenter: string
        id: 0
        virtualIp: string
    secondaryDestVip:
        datacenter: string
        id: 0
        virtualIp: string
    sourceIp: string
    withinCountry: false

    TrafficForwardingGreTunnel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TrafficForwardingGreTunnel resource accepts the following input properties:

    SourceIp string
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    Comment string
    Additional information about the GRE tunnel.
    CountryCode string
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    InternalIpRange string
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    IpUnnumbered bool
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    PrimaryDestVip zscaler.PulumiPackage.Zia.Inputs.GreTunnelDestVipInput
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    SecondaryDestVip zscaler.PulumiPackage.Zia.Inputs.GreTunnelDestVipInput
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    WithinCountry bool
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.
    SourceIp string
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    Comment string
    Additional information about the GRE tunnel.
    CountryCode string
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    InternalIpRange string
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    IpUnnumbered bool
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    PrimaryDestVip GreTunnelDestVipInputArgs
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    SecondaryDestVip GreTunnelDestVipInputArgs
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    WithinCountry bool
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.
    sourceIp String
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    comment String
    Additional information about the GRE tunnel.
    countryCode String
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    internalIpRange String
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    ipUnnumbered Boolean
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    primaryDestVip GreTunnelDestVipInput
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    secondaryDestVip GreTunnelDestVipInput
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    withinCountry Boolean
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.
    sourceIp string
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    comment string
    Additional information about the GRE tunnel.
    countryCode string
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    internalIpRange string
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    ipUnnumbered boolean
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    primaryDestVip GreTunnelDestVipInput
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    secondaryDestVip GreTunnelDestVipInput
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    withinCountry boolean
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.
    source_ip str
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    comment str
    Additional information about the GRE tunnel.
    country_code str
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    internal_ip_range str
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    ip_unnumbered bool
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    primary_dest_vip GreTunnelDestVipInputArgs
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    secondary_dest_vip GreTunnelDestVipInputArgs
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    within_country bool
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.
    sourceIp String
    The source IP address of the GRE tunnel. This is typically a static IP associated with the location.
    comment String
    Additional information about the GRE tunnel.
    countryCode String
    Country code (ISO 3166-1 alpha-2) used when withinCountry is true to restrict VIP selection.
    internalIpRange String
    The start of the internal IP address in /29 CIDR range. Automatically assigned if not provided.
    ipUnnumbered Boolean
    When set to true, indicates that the GRE tunnel interface is unnumbered (no internal IP range is assigned).
    primaryDestVip Property Map
    The primary destination data center and virtual IP address (VIP) of the GRE tunnel.
    secondaryDestVip Property Map
    The secondary destination data center and virtual IP address (VIP) of the GRE tunnel.
    withinCountry Boolean
    Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TrafficForwardingGreTunnel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TunnelId int
    The system-generated ID of the GRE tunnel.
    Id string
    The provider-assigned unique ID for this managed resource.
    TunnelId int
    The system-generated ID of the GRE tunnel.
    id String
    The provider-assigned unique ID for this managed resource.
    tunnelId Integer
    The system-generated ID of the GRE tunnel.
    id string
    The provider-assigned unique ID for this managed resource.
    tunnelId number
    The system-generated ID of the GRE tunnel.
    id str
    The provider-assigned unique ID for this managed resource.
    tunnel_id int
    The system-generated ID of the GRE tunnel.
    id String
    The provider-assigned unique ID for this managed resource.
    tunnelId Number
    The system-generated ID of the GRE tunnel.

    Supporting Types

    GreTunnelDestVipInput, GreTunnelDestVipInputArgs

    Datacenter string
    Id int
    VirtualIp string
    Datacenter string
    Id int
    VirtualIp string
    datacenter String
    id Integer
    virtualIp String
    datacenter string
    id number
    virtualIp string
    datacenter String
    id Number
    virtualIp String

    GreTunnelDestVipOutput, GreTunnelDestVipOutputArgs

    Datacenter string
    Id int
    VirtualIp string
    Datacenter string
    Id int
    VirtualIp string
    datacenter String
    id Integer
    virtualIp String
    datacenter string
    id number
    virtualIp string
    datacenter String
    id Number
    virtualIp String

    Import

    An existing GRE tunnel can be imported using its resource ID, e.g.

    $ pulumi import zia:index:TrafficForwardingGreTunnel example 12345

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.