1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getVirtualServiceEdgeCluster
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler

zia.getVirtualServiceEdgeCluster

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler

    Use the zia_virtual_service_edge_cluster data source to get information about a Virtual Service Edge Cluster information for the specified Name or ID

    data "zia_virtual_service_edge_cluster" "this"{
        name = "VSECluster01"
    }
    

    Using getVirtualServiceEdgeCluster

    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 getVirtualServiceEdgeCluster(args: GetVirtualServiceEdgeClusterArgs, opts?: InvokeOptions): Promise<GetVirtualServiceEdgeClusterResult>
    function getVirtualServiceEdgeClusterOutput(args: GetVirtualServiceEdgeClusterOutputArgs, opts?: InvokeOptions): Output<GetVirtualServiceEdgeClusterResult>
    def get_virtual_service_edge_cluster(id: Optional[int] = None,
                                         name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetVirtualServiceEdgeClusterResult
    def get_virtual_service_edge_cluster_output(id: Optional[pulumi.Input[int]] = None,
                                         name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetVirtualServiceEdgeClusterResult]
    func LookupVirtualServiceEdgeCluster(ctx *Context, args *LookupVirtualServiceEdgeClusterArgs, opts ...InvokeOption) (*LookupVirtualServiceEdgeClusterResult, error)
    func LookupVirtualServiceEdgeClusterOutput(ctx *Context, args *LookupVirtualServiceEdgeClusterOutputArgs, opts ...InvokeOption) LookupVirtualServiceEdgeClusterResultOutput

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

    public static class GetVirtualServiceEdgeCluster 
    {
        public static Task<GetVirtualServiceEdgeClusterResult> InvokeAsync(GetVirtualServiceEdgeClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetVirtualServiceEdgeClusterResult> Invoke(GetVirtualServiceEdgeClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVirtualServiceEdgeClusterResult> getVirtualServiceEdgeCluster(GetVirtualServiceEdgeClusterArgs args, InvokeOptions options)
    public static Output<GetVirtualServiceEdgeClusterResult> getVirtualServiceEdgeCluster(GetVirtualServiceEdgeClusterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zia:index/getVirtualServiceEdgeCluster:getVirtualServiceEdgeCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id int
    USystem-generated Virtual Service Edge cluster ID
    Name string
    Name of the Virtual Service Edge cluster
    Id int
    USystem-generated Virtual Service Edge cluster ID
    Name string
    Name of the Virtual Service Edge cluster
    id Integer
    USystem-generated Virtual Service Edge cluster ID
    name String
    Name of the Virtual Service Edge cluster
    id number
    USystem-generated Virtual Service Edge cluster ID
    name string
    Name of the Virtual Service Edge cluster
    id int
    USystem-generated Virtual Service Edge cluster ID
    name str
    Name of the Virtual Service Edge cluster
    id Number
    USystem-generated Virtual Service Edge cluster ID
    name String
    Name of the Virtual Service Edge cluster

    getVirtualServiceEdgeCluster Result

    The following output properties are available:

    DefaultGateway string
    (String) The IP address of the default gateway to the internet
    Id int
    (Number) Identifier that uniquely identifies an entity
    IpAddress string
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    IpSecEnabled bool
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    LastModifiedTime int
    (Number) When the cluster was last modified
    Name string
    (String) The configured name of the entity
    Status string
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    SubnetMask string
    (String) The Virtual Service Edge cluster subnet mask
    Type string
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    VirtualZenNodes List<zscaler.PulumiPackage.Zia.Outputs.GetVirtualServiceEdgeClusterVirtualZenNode>
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.
    DefaultGateway string
    (String) The IP address of the default gateway to the internet
    Id int
    (Number) Identifier that uniquely identifies an entity
    IpAddress string
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    IpSecEnabled bool
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    LastModifiedTime int
    (Number) When the cluster was last modified
    Name string
    (String) The configured name of the entity
    Status string
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    SubnetMask string
    (String) The Virtual Service Edge cluster subnet mask
    Type string
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    VirtualZenNodes []GetVirtualServiceEdgeClusterVirtualZenNode
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.
    defaultGateway String
    (String) The IP address of the default gateway to the internet
    id Integer
    (Number) Identifier that uniquely identifies an entity
    ipAddress String
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    ipSecEnabled Boolean
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    lastModifiedTime Integer
    (Number) When the cluster was last modified
    name String
    (String) The configured name of the entity
    status String
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    subnetMask String
    (String) The Virtual Service Edge cluster subnet mask
    type String
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    virtualZenNodes List<GetVirtualServiceEdgeClusterVirtualZenNode>
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.
    defaultGateway string
    (String) The IP address of the default gateway to the internet
    id number
    (Number) Identifier that uniquely identifies an entity
    ipAddress string
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    ipSecEnabled boolean
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    lastModifiedTime number
    (Number) When the cluster was last modified
    name string
    (String) The configured name of the entity
    status string
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    subnetMask string
    (String) The Virtual Service Edge cluster subnet mask
    type string
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    virtualZenNodes GetVirtualServiceEdgeClusterVirtualZenNode[]
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.
    default_gateway str
    (String) The IP address of the default gateway to the internet
    id int
    (Number) Identifier that uniquely identifies an entity
    ip_address str
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    ip_sec_enabled bool
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    last_modified_time int
    (Number) When the cluster was last modified
    name str
    (String) The configured name of the entity
    status str
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    subnet_mask str
    (String) The Virtual Service Edge cluster subnet mask
    type str
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    virtual_zen_nodes Sequence[GetVirtualServiceEdgeClusterVirtualZenNode]
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.
    defaultGateway String
    (String) The IP address of the default gateway to the internet
    id Number
    (Number) Identifier that uniquely identifies an entity
    ipAddress String
    (String) The Virtual Service Edge cluster IP address. In a Virtual Service Edge cluster, the cluster IP address provides fault tolerance and is used to listen for user traffic. This interface doesn't explicitly get an IP address. The cluster IP address must be in the same VLAN as the proxy and load balancer IP addresses.
    ipSecEnabled Boolean
    (String) A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster
    lastModifiedTime Number
    (Number) When the cluster was last modified
    name String
    (String) The configured name of the entity
    status String
    (Number) Specifies the status of the Virtual Service Edge cluster. The status is set to ENABLED by default.
    subnetMask String
    (String) The Virtual Service Edge cluster subnet mask
    type String
    (String) The Virtual Service Edge cluster type ANY, NONE, SME, SMSM, SMCA, SMUI, SMCDS, SMDNSD, SMAA, SMTP,SMQTN,VIP, UIZ, UIAE, SITEREVIEW, PAC, S_RELAY, M_RELAY, H_MON, SMIKE, NSS, SMEZA, SMLB, SMFCCLT, SMBA, SMBAC, SMESXI, SMBAUI, VZEN, ZSCMCLT, SMDLP, ZSQUERY, ADP, SMCDSDLP, SMSCIM, ZSAPI, ZSCMCDSSCLT, LOCAL_MTS, SVPN, SMCASB, SMFALCONUI, MOBILEAPP_REG, SMRESTSVR, FALCONCA, MOBILEAPP_NF, ZIRSVR, SMEDGEUI, ALERTEVAL, ALERTNOTIF, SMPARTNERUI, CQM, DATAKEEPER, SMBAM, ZWACLT
    virtualZenNodes List<Property Map>
    (List of Object) The Virtual Service Edge instances you want to include in the cluster. A Virtual Service Edge cluster must contain at least two Virtual Service Edge instances.

    Supporting Types

    GetVirtualServiceEdgeClusterVirtualZenNode

    Extensions Dictionary<string, string>
    (Map of String)
    ExternalId string
    (String) An external identifier used for an entity that is managed outside of ZIA.
    Id int
    USystem-generated Virtual Service Edge cluster ID
    Name string
    Name of the Virtual Service Edge cluster
    Extensions map[string]string
    (Map of String)
    ExternalId string
    (String) An external identifier used for an entity that is managed outside of ZIA.
    Id int
    USystem-generated Virtual Service Edge cluster ID
    Name string
    Name of the Virtual Service Edge cluster
    extensions Map<String,String>
    (Map of String)
    externalId String
    (String) An external identifier used for an entity that is managed outside of ZIA.
    id Integer
    USystem-generated Virtual Service Edge cluster ID
    name String
    Name of the Virtual Service Edge cluster
    extensions {[key: string]: string}
    (Map of String)
    externalId string
    (String) An external identifier used for an entity that is managed outside of ZIA.
    id number
    USystem-generated Virtual Service Edge cluster ID
    name string
    Name of the Virtual Service Edge cluster
    extensions Mapping[str, str]
    (Map of String)
    external_id str
    (String) An external identifier used for an entity that is managed outside of ZIA.
    id int
    USystem-generated Virtual Service Edge cluster ID
    name str
    Name of the Virtual Service Edge cluster
    extensions Map<String>
    (Map of String)
    externalId String
    (String) An external identifier used for an entity that is managed outside of ZIA.
    id Number
    USystem-generated Virtual Service Edge cluster ID
    name String
    Name of the Virtual Service Edge cluster

    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.1.1 published on Tuesday, Jun 24, 2025 by Zscaler