Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getLbaas
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getLbaas

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information of an existing IBM Cloud load balancer as a read-only data source. For more information, about load balancer as a service, see enabling auto scale for better capacity and resiliency.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  lbaas:
    type: ibm:Lbaas
    properties:
      datacenter: dal09
      description: updated desc-used for terraform uat
      protocols:
        - backendPort: 80
          backendProtocol: HTTP
          frontendPort: 80
          frontendProtocol: HTTP
          loadBalancingMethod: round_robin
      serverInstances:
        - privateIpAddress: 10.1.19.26
      subnets:
        - 1.878778e+06
variables:
  tfaccLbaas:
    fn::invoke:
      function: ibm:getLbaas
      arguments:
        name: test

    Using getLbaas

    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 getLbaas(args: GetLbaasArgs, opts?: InvokeOptions): Promise<GetLbaasResult>
function getLbaasOutput(args: GetLbaasOutputArgs, opts?: InvokeOptions): Output<GetLbaasResult>
    def get_lbaas(id: Optional[str] = None,
              name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetLbaasResult
def get_lbaas_output(id: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetLbaasResult]
    func LookupLbaas(ctx *Context, args *LookupLbaasArgs, opts ...InvokeOption) (*LookupLbaasResult, error)
func LookupLbaasOutput(ctx *Context, args *LookupLbaasOutputArgs, opts ...InvokeOption) LookupLbaasResultOutput

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

    public static class GetLbaas 
{
    public static Task<GetLbaasResult> InvokeAsync(GetLbaasArgs args, InvokeOptions? opts = null)
    public static Output<GetLbaasResult> Invoke(GetLbaasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLbaasResult> getLbaas(GetLbaasArgs args, InvokeOptions options)
public static Output<GetLbaasResult> getLbaas(GetLbaasArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getLbaas:getLbaas
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the load balancer.
    Id string
    Name string
    The name of the load balancer.
    Id string
    name String
    The name of the load balancer.
    id String
    name string
    The name of the load balancer.
    id string
    name str
    The name of the load balancer.
    id str
    name String
    The name of the load balancer.
    id String

    getLbaas Result

    The following output properties are available:

    ActiveConnections double
    (Integer) The number of total established connections.
    Datacenter string
    (String) The data center where load balancer is located.
    Description string
    (String) A description of the load balancer.
    HealthMonitors List<GetLbaasHealthMonitor>
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    Id string
    Name string
    Protocols List<GetLbaasProtocol>
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    ServerInstances List<GetLbaasServerInstance>
    ServerInstancesDown double
    (Integer) The number of service instances, that are in the DOWN health state.
    ServerInstancesUp double
    (Integer) The number of service instances, that are in the UP health state.
    SslCiphers List<string>
    (Array) The list of SSL offloads.
    Status string
    (String) Specifies the operation status of the load balancer as online or offline.
    Type string
    (String) Specifies whether a load balancer is public or private.
    UseSystemPublicIpPool bool
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    Vip string
    (String) The virtual IP address of the load balancer.
    ActiveConnections float64
    (Integer) The number of total established connections.
    Datacenter string
    (String) The data center where load balancer is located.
    Description string
    (String) A description of the load balancer.
    HealthMonitors []GetLbaasHealthMonitorType
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    Id string
    Name string
    Protocols []GetLbaasProtocol
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    ServerInstances []GetLbaasServerInstance
    ServerInstancesDown float64
    (Integer) The number of service instances, that are in the DOWN health state.
    ServerInstancesUp float64
    (Integer) The number of service instances, that are in the UP health state.
    SslCiphers []string
    (Array) The list of SSL offloads.
    Status string
    (String) Specifies the operation status of the load balancer as online or offline.
    Type string
    (String) Specifies whether a load balancer is public or private.
    UseSystemPublicIpPool bool
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    Vip string
    (String) The virtual IP address of the load balancer.
    activeConnections Double
    (Integer) The number of total established connections.
    datacenter String
    (String) The data center where load balancer is located.
    description String
    (String) A description of the load balancer.
    healthMonitors List<GetLbaasHealthMonitor>
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    id String
    name String
    protocols List<GetLbaasProtocol>
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    serverInstances List<GetLbaasServerInstance>
    serverInstancesDown Double
    (Integer) The number of service instances, that are in the DOWN health state.
    serverInstancesUp Double
    (Integer) The number of service instances, that are in the UP health state.
    sslCiphers List<String>
    (Array) The list of SSL offloads.
    status String
    (String) Specifies the operation status of the load balancer as online or offline.
    type String
    (String) Specifies whether a load balancer is public or private.
    useSystemPublicIpPool Boolean
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    vip String
    (String) The virtual IP address of the load balancer.
    activeConnections number
    (Integer) The number of total established connections.
    datacenter string
    (String) The data center where load balancer is located.
    description string
    (String) A description of the load balancer.
    healthMonitors GetLbaasHealthMonitor[]
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    id string
    name string
    protocols GetLbaasProtocol[]
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    serverInstances GetLbaasServerInstance[]
    serverInstancesDown number
    (Integer) The number of service instances, that are in the DOWN health state.
    serverInstancesUp number
    (Integer) The number of service instances, that are in the UP health state.
    sslCiphers string[]
    (Array) The list of SSL offloads.
    status string
    (String) Specifies the operation status of the load balancer as online or offline.
    type string
    (String) Specifies whether a load balancer is public or private.
    useSystemPublicIpPool boolean
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    vip string
    (String) The virtual IP address of the load balancer.
    active_connections float
    (Integer) The number of total established connections.
    datacenter str
    (String) The data center where load balancer is located.
    description str
    (String) A description of the load balancer.
    health_monitors Sequence[GetLbaasHealthMonitor]
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    id str
    name str
    protocols Sequence[GetLbaasProtocol]
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    server_instances Sequence[GetLbaasServerInstance]
    server_instances_down float
    (Integer) The number of service instances, that are in the DOWN health state.
    server_instances_up float
    (Integer) The number of service instances, that are in the UP health state.
    ssl_ciphers Sequence[str]
    (Array) The list of SSL offloads.
    status str
    (String) Specifies the operation status of the load balancer as online or offline.
    type str
    (String) Specifies whether a load balancer is public or private.
    use_system_public_ip_pool bool
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    vip str
    (String) The virtual IP address of the load balancer.
    activeConnections Number
    (Integer) The number of total established connections.
    datacenter String
    (String) The data center where load balancer is located.
    description String
    (String) A description of the load balancer.
    healthMonitors List<Property Map>
    (List of Objects) A nested block describes the health_monitors assigned to the load balancer.
    id String
    name String
    protocols List<Property Map>
    (List of Objects) A nested block describes the protocols that are assigned to the load balancer.
    serverInstances List<Property Map>
    serverInstancesDown Number
    (Integer) The number of service instances, that are in the DOWN health state.
    serverInstancesUp Number
    (Integer) The number of service instances, that are in the UP health state.
    sslCiphers List<String>
    (Array) The list of SSL offloads.
    status String
    (String) Specifies the operation status of the load balancer as online or offline.
    type String
    (String) Specifies whether a load balancer is public or private.
    useSystemPublicIpPool Boolean
    (String) It specifies whether the public IP addresses are allocated from system public IP pool or public subnet from the account order of the load balancer.
    vip String
    (String) The virtual IP address of the load balancer.

    Supporting Types

    GetLbaasHealthMonitor

    Interval double
    (Integer) The interval in seconds to perform the health check.
    MaxRetries double
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    MonitorId string
    (String) The health monitor UUID.
    Port double
    (String) The backend port.
    Protocol string
    (String) The backend protocol.
    Timeout double
    (String) The health check method.
    UrlPath string
    (String) If monitor is "HTTP", it specifies the URL path.
    Interval float64
    (Integer) The interval in seconds to perform the health check.
    MaxRetries float64
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    MonitorId string
    (String) The health monitor UUID.
    Port float64
    (String) The backend port.
    Protocol string
    (String) The backend protocol.
    Timeout float64
    (String) The health check method.
    UrlPath string
    (String) If monitor is "HTTP", it specifies the URL path.
    interval Double
    (Integer) The interval in seconds to perform the health check.
    maxRetries Double
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    monitorId String
    (String) The health monitor UUID.
    port Double
    (String) The backend port.
    protocol String
    (String) The backend protocol.
    timeout Double
    (String) The health check method.
    urlPath String
    (String) If monitor is "HTTP", it specifies the URL path.
    interval number
    (Integer) The interval in seconds to perform the health check.
    maxRetries number
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    monitorId string
    (String) The health monitor UUID.
    port number
    (String) The backend port.
    protocol string
    (String) The backend protocol.
    timeout number
    (String) The health check method.
    urlPath string
    (String) If monitor is "HTTP", it specifies the URL path.
    interval float
    (Integer) The interval in seconds to perform the health check.
    max_retries float
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    monitor_id str
    (String) The health monitor UUID.
    port float
    (String) The backend port.
    protocol str
    (String) The backend protocol.
    timeout float
    (String) The health check method.
    url_path str
    (String) If monitor is "HTTP", it specifies the URL path.
    interval Number
    (Integer) The interval in seconds to perform the health check.
    maxRetries Number
    (Integer) The maximum retries before the load balancer are considered unhealthy.
    monitorId String
    (String) The health monitor UUID.
    port Number
    (String) The backend port.
    protocol String
    (String) The backend protocol.
    timeout Number
    (String) The health check method.
    urlPath String
    (String) If monitor is "HTTP", it specifies the URL path.

    GetLbaasProtocol

    BackendPort double
    (Integer) The backend protocol port number.
    BackendProtocol string
    (String) The backend protocol.
    FrontendPort double
    (Integer) The front-end protocol port number.
    FrontendProtocol string
    (String) The front-end protocol.
    LoadBalancingMethod string
    (String) The load-balancing algorithm.
    MaxConn double
    (Integer) The number of connections the listener can accept.
    ProtocolId string
    (String) The UUID of a load balancer protocol.
    SessionStickiness string
    (Bool) Session stickiness.
    TlsCertificateId double
    (String) The ID of the SSL/TLS certificate used for a protocol.
    BackendPort float64
    (Integer) The backend protocol port number.
    BackendProtocol string
    (String) The backend protocol.
    FrontendPort float64
    (Integer) The front-end protocol port number.
    FrontendProtocol string
    (String) The front-end protocol.
    LoadBalancingMethod string
    (String) The load-balancing algorithm.
    MaxConn float64
    (Integer) The number of connections the listener can accept.
    ProtocolId string
    (String) The UUID of a load balancer protocol.
    SessionStickiness string
    (Bool) Session stickiness.
    TlsCertificateId float64
    (String) The ID of the SSL/TLS certificate used for a protocol.
    backendPort Double
    (Integer) The backend protocol port number.
    backendProtocol String
    (String) The backend protocol.
    frontendPort Double
    (Integer) The front-end protocol port number.
    frontendProtocol String
    (String) The front-end protocol.
    loadBalancingMethod String
    (String) The load-balancing algorithm.
    maxConn Double
    (Integer) The number of connections the listener can accept.
    protocolId String
    (String) The UUID of a load balancer protocol.
    sessionStickiness String
    (Bool) Session stickiness.
    tlsCertificateId Double
    (String) The ID of the SSL/TLS certificate used for a protocol.
    backendPort number
    (Integer) The backend protocol port number.
    backendProtocol string
    (String) The backend protocol.
    frontendPort number
    (Integer) The front-end protocol port number.
    frontendProtocol string
    (String) The front-end protocol.
    loadBalancingMethod string
    (String) The load-balancing algorithm.
    maxConn number
    (Integer) The number of connections the listener can accept.
    protocolId string
    (String) The UUID of a load balancer protocol.
    sessionStickiness string
    (Bool) Session stickiness.
    tlsCertificateId number
    (String) The ID of the SSL/TLS certificate used for a protocol.
    backend_port float
    (Integer) The backend protocol port number.
    backend_protocol str
    (String) The backend protocol.
    frontend_port float
    (Integer) The front-end protocol port number.
    frontend_protocol str
    (String) The front-end protocol.
    load_balancing_method str
    (String) The load-balancing algorithm.
    max_conn float
    (Integer) The number of connections the listener can accept.
    protocol_id str
    (String) The UUID of a load balancer protocol.
    session_stickiness str
    (Bool) Session stickiness.
    tls_certificate_id float
    (String) The ID of the SSL/TLS certificate used for a protocol.
    backendPort Number
    (Integer) The backend protocol port number.
    backendProtocol String
    (String) The backend protocol.
    frontendPort Number
    (Integer) The front-end protocol port number.
    frontendProtocol String
    (String) The front-end protocol.
    loadBalancingMethod String
    (String) The load-balancing algorithm.
    maxConn Number
    (Integer) The number of connections the listener can accept.
    protocolId String
    (String) The UUID of a load balancer protocol.
    sessionStickiness String
    (Bool) Session stickiness.
    tlsCertificateId Number
    (String) The ID of the SSL/TLS certificate used for a protocol.

    GetLbaasServerInstance

    MemberId string
    PrivateIpAddress string
    Status string
    (String) Specifies the operation status of the load balancer as online or offline.
    Weight double
    MemberId string
    PrivateIpAddress string
    Status string
    (String) Specifies the operation status of the load balancer as online or offline.
    Weight float64
    memberId String
    privateIpAddress String
    status String
    (String) Specifies the operation status of the load balancer as online or offline.
    weight Double
    memberId string
    privateIpAddress string
    status string
    (String) Specifies the operation status of the load balancer as online or offline.
    weight number
    member_id str
    private_ip_address str
    status str
    (String) Specifies the operation status of the load balancer as online or offline.
    weight float
    memberId String
    privateIpAddress String
    status String
    (String) Specifies the operation status of the load balancer as online or offline.
    weight Number

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm