Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getTrafficForwardingVIPRecommendedList
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

zia.getTrafficForwardingVIPRecommendedList

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
zscaler/pulumi-zia

    Use the zia_traffic_forwarding_gre_vip_recommended_list data source to get information about a list of recommended GRE tunnel virtual IP addresses (VIPs), based on source IP address or latitude/longitude coordinates.

    Example Usage

    # ZIA Traffic Forwarding - GRE VIP Recommended List
data "zia_traffic_forwarding_gre_vip_recommended_list" "this"{
    source_ip = "1.1.1.1"
    required_count = 2
}

    With Overridden Geo Coordinates

    # ZIA Traffic Forwarding - GRE VIP Recommended List
data "zia_traffic_forwarding_gre_vip_recommended_list" "this"{
    source_ip = "1.1.1.1"
    required_count = 2
    latitude     = 22.2914
    longitude    = 114.1445
}

    Using getTrafficForwardingVIPRecommendedList

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTrafficForwardingVIPRecommendedList(args: GetTrafficForwardingVIPRecommendedListArgs, opts?: InvokeOptions): Promise<GetTrafficForwardingVIPRecommendedListResult>
function getTrafficForwardingVIPRecommendedListOutput(args: GetTrafficForwardingVIPRecommendedListOutputArgs, opts?: InvokeOptions): Output<GetTrafficForwardingVIPRecommendedListResult>
    def get_traffic_forwarding_vip_recommended_list(include_current_vips: Optional[bool] = None,
                                                include_private_service_edge: Optional[bool] = None,
                                                latitude: Optional[float] = None,
                                                longitude: Optional[float] = None,
                                                required_count: Optional[int] = None,
                                                routable_ip: Optional[bool] = None,
                                                source_ip: Optional[str] = None,
                                                subcloud: Optional[str] = None,
                                                within_country_only: Optional[bool] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetTrafficForwardingVIPRecommendedListResult
def get_traffic_forwarding_vip_recommended_list_output(include_current_vips: Optional[pulumi.Input[bool]] = None,
                                                include_private_service_edge: Optional[pulumi.Input[bool]] = None,
                                                latitude: Optional[pulumi.Input[float]] = None,
                                                longitude: Optional[pulumi.Input[float]] = None,
                                                required_count: Optional[pulumi.Input[int]] = None,
                                                routable_ip: Optional[pulumi.Input[bool]] = None,
                                                source_ip: Optional[pulumi.Input[str]] = None,
                                                subcloud: Optional[pulumi.Input[str]] = None,
                                                within_country_only: Optional[pulumi.Input[bool]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetTrafficForwardingVIPRecommendedListResult]
    func GetTrafficForwardingVIPRecommendedList(ctx *Context, args *GetTrafficForwardingVIPRecommendedListArgs, opts ...InvokeOption) (*GetTrafficForwardingVIPRecommendedListResult, error)
func GetTrafficForwardingVIPRecommendedListOutput(ctx *Context, args *GetTrafficForwardingVIPRecommendedListOutputArgs, opts ...InvokeOption) GetTrafficForwardingVIPRecommendedListResultOutput

    > Note: This function is named GetTrafficForwardingVIPRecommendedList in the Go SDK.

    public static class GetTrafficForwardingVIPRecommendedList 
{
    public static Task<GetTrafficForwardingVIPRecommendedListResult> InvokeAsync(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions? opts = null)
    public static Output<GetTrafficForwardingVIPRecommendedListResult> Invoke(GetTrafficForwardingVIPRecommendedListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTrafficForwardingVIPRecommendedListResult> getTrafficForwardingVIPRecommendedList(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions options)
public static Output<GetTrafficForwardingVIPRecommendedListResult> getTrafficForwardingVIPRecommendedList(GetTrafficForwardingVIPRecommendedListArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:index/getTrafficForwardingVIPRecommendedList:getTrafficForwardingVIPRecommendedList
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IncludeCurrentVips bool
    (Boolean) Include currently assigned VIPs.
    IncludePrivateServiceEdge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    Latitude double
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude double
    (Number) The longitude coordinate of the GRE tunnel source.
    RequiredCount int
    Number of IP address to be exported.
    RoutableIp bool
    (Boolean) The routable IP address.
    SourceIp string
    Filter based on an IP address range.
    Subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    WithinCountryOnly bool
    (Boolean) Search within country only.
    IncludeCurrentVips bool
    (Boolean) Include currently assigned VIPs.
    IncludePrivateServiceEdge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    Latitude float64
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude float64
    (Number) The longitude coordinate of the GRE tunnel source.
    RequiredCount int
    Number of IP address to be exported.
    RoutableIp bool
    (Boolean) The routable IP address.
    SourceIp string
    Filter based on an IP address range.
    Subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    WithinCountryOnly bool
    (Boolean) Search within country only.
    includeCurrentVips Boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge Boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude Double
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Double
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount Integer
    Number of IP address to be exported.
    routableIp Boolean
    (Boolean) The routable IP address.
    sourceIp String
    Filter based on an IP address range.
    subcloud String
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly Boolean
    (Boolean) Search within country only.
    includeCurrentVips boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude number
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount number
    Number of IP address to be exported.
    routableIp boolean
    (Boolean) The routable IP address.
    sourceIp string
    Filter based on an IP address range.
    subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly boolean
    (Boolean) Search within country only.
    include_current_vips bool
    (Boolean) Include currently assigned VIPs.
    include_private_service_edge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude float
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude float
    (Number) The longitude coordinate of the GRE tunnel source.
    required_count int
    Number of IP address to be exported.
    routable_ip bool
    (Boolean) The routable IP address.
    source_ip str
    Filter based on an IP address range.
    subcloud str
    (String) The longitude coordinate of the GRE tunnel source.
    within_country_only bool
    (Boolean) Search within country only.
    includeCurrentVips Boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge Boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude Number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Number
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount Number
    Number of IP address to be exported.
    routableIp Boolean
    (Boolean) The routable IP address.
    sourceIp String
    Filter based on an IP address range.
    subcloud String
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly Boolean
    (Boolean) Search within country only.

    getTrafficForwardingVIPRecommendedList Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Lists List<zscaler.PulumiPackage.Zia.Outputs.GetTrafficForwardingVIPRecommendedListList>
    The list of all recommended returned Virtual IP Addresses (VIPs)
    IncludeCurrentVips bool
    (Boolean) Include currently assigned VIPs.
    IncludePrivateServiceEdge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    Latitude double
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude double
    (Number) The longitude coordinate of the GRE tunnel source.
    RequiredCount int
    RoutableIp bool
    (Boolean) The routable IP address.
    SourceIp string
    (String) The public source IP address.
    Subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    WithinCountryOnly bool
    (Boolean) Search within country only.
    Id string
    The provider-assigned unique ID for this managed resource.
    Lists []GetTrafficForwardingVIPRecommendedListList
    The list of all recommended returned Virtual IP Addresses (VIPs)
    IncludeCurrentVips bool
    (Boolean) Include currently assigned VIPs.
    IncludePrivateServiceEdge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    Latitude float64
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude float64
    (Number) The longitude coordinate of the GRE tunnel source.
    RequiredCount int
    RoutableIp bool
    (Boolean) The routable IP address.
    SourceIp string
    (String) The public source IP address.
    Subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    WithinCountryOnly bool
    (Boolean) Search within country only.
    id String
    The provider-assigned unique ID for this managed resource.
    lists List<GetTrafficForwardingVIPRecommendedListList>
    The list of all recommended returned Virtual IP Addresses (VIPs)
    includeCurrentVips Boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge Boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude Double
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Double
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount Integer
    routableIp Boolean
    (Boolean) The routable IP address.
    sourceIp String
    (String) The public source IP address.
    subcloud String
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly Boolean
    (Boolean) Search within country only.
    id string
    The provider-assigned unique ID for this managed resource.
    lists GetTrafficForwardingVIPRecommendedListList[]
    The list of all recommended returned Virtual IP Addresses (VIPs)
    includeCurrentVips boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude number
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount number
    routableIp boolean
    (Boolean) The routable IP address.
    sourceIp string
    (String) The public source IP address.
    subcloud string
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly boolean
    (Boolean) Search within country only.
    id str
    The provider-assigned unique ID for this managed resource.
    lists Sequence[GetTrafficForwardingVIPRecommendedListList]
    The list of all recommended returned Virtual IP Addresses (VIPs)
    include_current_vips bool
    (Boolean) Include currently assigned VIPs.
    include_private_service_edge bool
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude float
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude float
    (Number) The longitude coordinate of the GRE tunnel source.
    required_count int
    routable_ip bool
    (Boolean) The routable IP address.
    source_ip str
    (String) The public source IP address.
    subcloud str
    (String) The longitude coordinate of the GRE tunnel source.
    within_country_only bool
    (Boolean) Search within country only.
    id String
    The provider-assigned unique ID for this managed resource.
    lists List<Property Map>
    The list of all recommended returned Virtual IP Addresses (VIPs)
    includeCurrentVips Boolean
    (Boolean) Include currently assigned VIPs.
    includePrivateServiceEdge Boolean
    (Boolean) Include ZIA Private Service Edge VIPs.
    latitude Number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Number
    (Number) The longitude coordinate of the GRE tunnel source.
    requiredCount Number
    routableIp Boolean
    (Boolean) The routable IP address.
    sourceIp String
    (String) The public source IP address.
    subcloud String
    (String) The longitude coordinate of the GRE tunnel source.
    withinCountryOnly Boolean
    (Boolean) Search within country only.

    Supporting Types

    GetTrafficForwardingVIPRecommendedListList

    City string
    (String) Data center city information
    Latitude double
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude double
    (Number) The longitude coordinate of the GRE tunnel source.
    Region string
    (String) Data center region information.
    Datacenter string
    (String) Data center information
    Id int
    Unique identifer of the GRE virtual IP address (VIP)
    PrivateServiceEdge bool
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    VirtualIp string
    (String) GRE cluster virtual IP address (VIP)
    City string
    (String) Data center city information
    Latitude float64
    (Number) The latitude coordinate of the GRE tunnel source.
    Longitude float64
    (Number) The longitude coordinate of the GRE tunnel source.
    Region string
    (String) Data center region information.
    Datacenter string
    (String) Data center information
    Id int
    Unique identifer of the GRE virtual IP address (VIP)
    PrivateServiceEdge bool
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    VirtualIp string
    (String) GRE cluster virtual IP address (VIP)
    city String
    (String) Data center city information
    latitude Double
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Double
    (Number) The longitude coordinate of the GRE tunnel source.
    region String
    (String) Data center region information.
    datacenter String
    (String) Data center information
    id Integer
    Unique identifer of the GRE virtual IP address (VIP)
    privateServiceEdge Boolean
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    virtualIp String
    (String) GRE cluster virtual IP address (VIP)
    city string
    (String) Data center city information
    latitude number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude number
    (Number) The longitude coordinate of the GRE tunnel source.
    region string
    (String) Data center region information.
    datacenter string
    (String) Data center information
    id number
    Unique identifer of the GRE virtual IP address (VIP)
    privateServiceEdge boolean
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    virtualIp string
    (String) GRE cluster virtual IP address (VIP)
    city str
    (String) Data center city information
    latitude float
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude float
    (Number) The longitude coordinate of the GRE tunnel source.
    region str
    (String) Data center region information.
    datacenter str
    (String) Data center information
    id int
    Unique identifer of the GRE virtual IP address (VIP)
    private_service_edge bool
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    virtual_ip str
    (String) GRE cluster virtual IP address (VIP)
    city String
    (String) Data center city information
    latitude Number
    (Number) The latitude coordinate of the GRE tunnel source.
    longitude Number
    (Number) The longitude coordinate of the GRE tunnel source.
    region String
    (String) Data center region information.
    datacenter String
    (String) Data center information
    id Number
    Unique identifer of the GRE virtual IP address (VIP)
    privateServiceEdge Boolean
    (Boolean) Set to true if the virtual IP address (VIP) is a ZIA Private Service Edge
    virtualIp String
    (String) GRE cluster virtual IP address (VIP)

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v1.0.1 published on Friday, Jun 6, 2025 by Zscaler
    zscaler/pulumi-zia