Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. LbVirtualServer
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.LbVirtualServer

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create LbVirtualServer Resource

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

    Constructor syntax

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

@overload
def LbVirtualServer(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    port: Optional[float] = None,
                    edge_gateway: Optional[str] = None,
                    protocol: Optional[str] = None,
                    ip_address: Optional[str] = None,
                    lb_virtual_server_id: Optional[str] = None,
                    description: Optional[str] = None,
                    app_rule_ids: Optional[Sequence[str]] = None,
                    enable_acceleration: Optional[bool] = None,
                    connection_rate_limit: Optional[float] = None,
                    enabled: Optional[bool] = None,
                    name: Optional[str] = None,
                    org: Optional[str] = None,
                    app_profile_id: Optional[str] = None,
                    connection_limit: Optional[float] = None,
                    server_pool_id: Optional[str] = None,
                    vdc: Optional[str] = None)
    func NewLbVirtualServer(ctx *Context, name string, args LbVirtualServerArgs, opts ...ResourceOption) (*LbVirtualServer, error)
    public LbVirtualServer(string name, LbVirtualServerArgs args, CustomResourceOptions? opts = null)
    public LbVirtualServer(String name, LbVirtualServerArgs args)
public LbVirtualServer(String name, LbVirtualServerArgs args, CustomResourceOptions options)

    type: vcd:LbVirtualServer
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 LbVirtualServerArgs
    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 LbVirtualServerArgs
    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 LbVirtualServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbVirtualServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbVirtualServerArgs
    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 lbVirtualServerResource = new Vcd.LbVirtualServer("lbVirtualServerResource", new()
{
    Port = 0,
    EdgeGateway = "string",
    Protocol = "string",
    IpAddress = "string",
    LbVirtualServerId = "string",
    Description = "string",
    AppRuleIds = new[]
    {
        "string",
    },
    EnableAcceleration = false,
    ConnectionRateLimit = 0,
    Enabled = false,
    Name = "string",
    Org = "string",
    AppProfileId = "string",
    ConnectionLimit = 0,
    ServerPoolId = "string",
    Vdc = "string",
});

    example, err := vcd.NewLbVirtualServer(ctx, "lbVirtualServerResource", &vcd.LbVirtualServerArgs{
	Port:              pulumi.Float64(0),
	EdgeGateway:       pulumi.String("string"),
	Protocol:          pulumi.String("string"),
	IpAddress:         pulumi.String("string"),
	LbVirtualServerId: pulumi.String("string"),
	Description:       pulumi.String("string"),
	AppRuleIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableAcceleration:  pulumi.Bool(false),
	ConnectionRateLimit: pulumi.Float64(0),
	Enabled:             pulumi.Bool(false),
	Name:                pulumi.String("string"),
	Org:                 pulumi.String("string"),
	AppProfileId:        pulumi.String("string"),
	ConnectionLimit:     pulumi.Float64(0),
	ServerPoolId:        pulumi.String("string"),
	Vdc:                 pulumi.String("string"),
})

    var lbVirtualServerResource = new LbVirtualServer("lbVirtualServerResource", LbVirtualServerArgs.builder()
    .port(0)
    .edgeGateway("string")
    .protocol("string")
    .ipAddress("string")
    .lbVirtualServerId("string")
    .description("string")
    .appRuleIds("string")
    .enableAcceleration(false)
    .connectionRateLimit(0)
    .enabled(false)
    .name("string")
    .org("string")
    .appProfileId("string")
    .connectionLimit(0)
    .serverPoolId("string")
    .vdc("string")
    .build());

    lb_virtual_server_resource = vcd.LbVirtualServer("lbVirtualServerResource",
    port=0,
    edge_gateway="string",
    protocol="string",
    ip_address="string",
    lb_virtual_server_id="string",
    description="string",
    app_rule_ids=["string"],
    enable_acceleration=False,
    connection_rate_limit=0,
    enabled=False,
    name="string",
    org="string",
    app_profile_id="string",
    connection_limit=0,
    server_pool_id="string",
    vdc="string")

    const lbVirtualServerResource = new vcd.LbVirtualServer("lbVirtualServerResource", {
    port: 0,
    edgeGateway: "string",
    protocol: "string",
    ipAddress: "string",
    lbVirtualServerId: "string",
    description: "string",
    appRuleIds: ["string"],
    enableAcceleration: false,
    connectionRateLimit: 0,
    enabled: false,
    name: "string",
    org: "string",
    appProfileId: "string",
    connectionLimit: 0,
    serverPoolId: "string",
    vdc: "string",
});

    type: vcd:LbVirtualServer
properties:
    appProfileId: string
    appRuleIds:
        - string
    connectionLimit: 0
    connectionRateLimit: 0
    description: string
    edgeGateway: string
    enableAcceleration: false
    enabled: false
    ipAddress: string
    lbVirtualServerId: string
    name: string
    org: string
    port: 0
    protocol: string
    serverPoolId: string
    vdc: string

    LbVirtualServer 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 LbVirtualServer resource accepts the following input properties:

    EdgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    IpAddress string
    Set the IP address that the load balancer listens on
    Port double
    The port number that the load balancer listens on
    Protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    AppProfileId string
    Application profile ID to be associated with the virtual server
    AppRuleIds List<string>
    List of attached application rule IDs
    ConnectionLimit double
    Maximum concurrent connections that the virtual server can process
    ConnectionRateLimit double
    Maximum incoming new connection requests per second
    Description string
    Virtual server description
    EnableAcceleration bool
    Defines if the virtual server uses acceleration. Default false
    Enabled bool
    Defines if the virtual server is enabled. Default true
    LbVirtualServerId string
    The NSX ID of the load balancer virtual server
    Name string
    Virtual server name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ServerPoolId string
    The server pool that the load balancer will use
    Vdc string
    The name of VDC to use, optional if defined at provider level
    EdgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    IpAddress string
    Set the IP address that the load balancer listens on
    Port float64
    The port number that the load balancer listens on
    Protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    AppProfileId string
    Application profile ID to be associated with the virtual server
    AppRuleIds []string
    List of attached application rule IDs
    ConnectionLimit float64
    Maximum concurrent connections that the virtual server can process
    ConnectionRateLimit float64
    Maximum incoming new connection requests per second
    Description string
    Virtual server description
    EnableAcceleration bool
    Defines if the virtual server uses acceleration. Default false
    Enabled bool
    Defines if the virtual server is enabled. Default true
    LbVirtualServerId string
    The NSX ID of the load balancer virtual server
    Name string
    Virtual server name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ServerPoolId string
    The server pool that the load balancer will use
    Vdc string
    The name of VDC to use, optional if defined at provider level
    edgeGateway String
    The name of the edge gateway on which the virtual server is to be created
    ipAddress String
    Set the IP address that the load balancer listens on
    port Double
    The port number that the load balancer listens on
    protocol String
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    appProfileId String
    Application profile ID to be associated with the virtual server
    appRuleIds List<String>
    List of attached application rule IDs
    connectionLimit Double
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit Double
    Maximum incoming new connection requests per second
    description String
    Virtual server description
    enableAcceleration Boolean
    Defines if the virtual server uses acceleration. Default false
    enabled Boolean
    Defines if the virtual server is enabled. Default true
    lbVirtualServerId String
    The NSX ID of the load balancer virtual server
    name String
    Virtual server name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    serverPoolId String
    The server pool that the load balancer will use
    vdc String
    The name of VDC to use, optional if defined at provider level
    edgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    ipAddress string
    Set the IP address that the load balancer listens on
    port number
    The port number that the load balancer listens on
    protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    appProfileId string
    Application profile ID to be associated with the virtual server
    appRuleIds string[]
    List of attached application rule IDs
    connectionLimit number
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit number
    Maximum incoming new connection requests per second
    description string
    Virtual server description
    enableAcceleration boolean
    Defines if the virtual server uses acceleration. Default false
    enabled boolean
    Defines if the virtual server is enabled. Default true
    lbVirtualServerId string
    The NSX ID of the load balancer virtual server
    name string
    Virtual server name
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    serverPoolId string
    The server pool that the load balancer will use
    vdc string
    The name of VDC to use, optional if defined at provider level
    edge_gateway str
    The name of the edge gateway on which the virtual server is to be created
    ip_address str
    Set the IP address that the load balancer listens on
    port float
    The port number that the load balancer listens on
    protocol str
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    app_profile_id str
    Application profile ID to be associated with the virtual server
    app_rule_ids Sequence[str]
    List of attached application rule IDs
    connection_limit float
    Maximum concurrent connections that the virtual server can process
    connection_rate_limit float
    Maximum incoming new connection requests per second
    description str
    Virtual server description
    enable_acceleration bool
    Defines if the virtual server uses acceleration. Default false
    enabled bool
    Defines if the virtual server is enabled. Default true
    lb_virtual_server_id str
    The NSX ID of the load balancer virtual server
    name str
    Virtual server name
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    server_pool_id str
    The server pool that the load balancer will use
    vdc str
    The name of VDC to use, optional if defined at provider level
    edgeGateway String
    The name of the edge gateway on which the virtual server is to be created
    ipAddress String
    Set the IP address that the load balancer listens on
    port Number
    The port number that the load balancer listens on
    protocol String
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    appProfileId String
    Application profile ID to be associated with the virtual server
    appRuleIds List<String>
    List of attached application rule IDs
    connectionLimit Number
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit Number
    Maximum incoming new connection requests per second
    description String
    Virtual server description
    enableAcceleration Boolean
    Defines if the virtual server uses acceleration. Default false
    enabled Boolean
    Defines if the virtual server is enabled. Default true
    lbVirtualServerId String
    The NSX ID of the load balancer virtual server
    name String
    Virtual server name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    serverPoolId String
    The server pool that the load balancer will use
    vdc String
    The name of VDC to use, optional if defined at provider level

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing LbVirtualServer Resource

    Get an existing LbVirtualServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LbVirtualServerState, opts?: CustomResourceOptions): LbVirtualServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_profile_id: Optional[str] = None,
        app_rule_ids: Optional[Sequence[str]] = None,
        connection_limit: Optional[float] = None,
        connection_rate_limit: Optional[float] = None,
        description: Optional[str] = None,
        edge_gateway: Optional[str] = None,
        enable_acceleration: Optional[bool] = None,
        enabled: Optional[bool] = None,
        ip_address: Optional[str] = None,
        lb_virtual_server_id: Optional[str] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        port: Optional[float] = None,
        protocol: Optional[str] = None,
        server_pool_id: Optional[str] = None,
        vdc: Optional[str] = None) -> LbVirtualServer
    func GetLbVirtualServer(ctx *Context, name string, id IDInput, state *LbVirtualServerState, opts ...ResourceOption) (*LbVirtualServer, error)
    public static LbVirtualServer Get(string name, Input<string> id, LbVirtualServerState? state, CustomResourceOptions? opts = null)
    public static LbVirtualServer get(String name, Output<String> id, LbVirtualServerState state, CustomResourceOptions options)
    resources:  _:    type: vcd:LbVirtualServer    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppProfileId string
    Application profile ID to be associated with the virtual server
    AppRuleIds List<string>
    List of attached application rule IDs
    ConnectionLimit double
    Maximum concurrent connections that the virtual server can process
    ConnectionRateLimit double
    Maximum incoming new connection requests per second
    Description string
    Virtual server description
    EdgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    EnableAcceleration bool
    Defines if the virtual server uses acceleration. Default false
    Enabled bool
    Defines if the virtual server is enabled. Default true
    IpAddress string
    Set the IP address that the load balancer listens on
    LbVirtualServerId string
    The NSX ID of the load balancer virtual server
    Name string
    Virtual server name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Port double
    The port number that the load balancer listens on
    Protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    ServerPoolId string
    The server pool that the load balancer will use
    Vdc string
    The name of VDC to use, optional if defined at provider level
    AppProfileId string
    Application profile ID to be associated with the virtual server
    AppRuleIds []string
    List of attached application rule IDs
    ConnectionLimit float64
    Maximum concurrent connections that the virtual server can process
    ConnectionRateLimit float64
    Maximum incoming new connection requests per second
    Description string
    Virtual server description
    EdgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    EnableAcceleration bool
    Defines if the virtual server uses acceleration. Default false
    Enabled bool
    Defines if the virtual server is enabled. Default true
    IpAddress string
    Set the IP address that the load balancer listens on
    LbVirtualServerId string
    The NSX ID of the load balancer virtual server
    Name string
    Virtual server name
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Port float64
    The port number that the load balancer listens on
    Protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    ServerPoolId string
    The server pool that the load balancer will use
    Vdc string
    The name of VDC to use, optional if defined at provider level
    appProfileId String
    Application profile ID to be associated with the virtual server
    appRuleIds List<String>
    List of attached application rule IDs
    connectionLimit Double
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit Double
    Maximum incoming new connection requests per second
    description String
    Virtual server description
    edgeGateway String
    The name of the edge gateway on which the virtual server is to be created
    enableAcceleration Boolean
    Defines if the virtual server uses acceleration. Default false
    enabled Boolean
    Defines if the virtual server is enabled. Default true
    ipAddress String
    Set the IP address that the load balancer listens on
    lbVirtualServerId String
    The NSX ID of the load balancer virtual server
    name String
    Virtual server name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    port Double
    The port number that the load balancer listens on
    protocol String
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    serverPoolId String
    The server pool that the load balancer will use
    vdc String
    The name of VDC to use, optional if defined at provider level
    appProfileId string
    Application profile ID to be associated with the virtual server
    appRuleIds string[]
    List of attached application rule IDs
    connectionLimit number
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit number
    Maximum incoming new connection requests per second
    description string
    Virtual server description
    edgeGateway string
    The name of the edge gateway on which the virtual server is to be created
    enableAcceleration boolean
    Defines if the virtual server uses acceleration. Default false
    enabled boolean
    Defines if the virtual server is enabled. Default true
    ipAddress string
    Set the IP address that the load balancer listens on
    lbVirtualServerId string
    The NSX ID of the load balancer virtual server
    name string
    Virtual server name
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    port number
    The port number that the load balancer listens on
    protocol string
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    serverPoolId string
    The server pool that the load balancer will use
    vdc string
    The name of VDC to use, optional if defined at provider level
    app_profile_id str
    Application profile ID to be associated with the virtual server
    app_rule_ids Sequence[str]
    List of attached application rule IDs
    connection_limit float
    Maximum concurrent connections that the virtual server can process
    connection_rate_limit float
    Maximum incoming new connection requests per second
    description str
    Virtual server description
    edge_gateway str
    The name of the edge gateway on which the virtual server is to be created
    enable_acceleration bool
    Defines if the virtual server uses acceleration. Default false
    enabled bool
    Defines if the virtual server is enabled. Default true
    ip_address str
    Set the IP address that the load balancer listens on
    lb_virtual_server_id str
    The NSX ID of the load balancer virtual server
    name str
    Virtual server name
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    port float
    The port number that the load balancer listens on
    protocol str
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    server_pool_id str
    The server pool that the load balancer will use
    vdc str
    The name of VDC to use, optional if defined at provider level
    appProfileId String
    Application profile ID to be associated with the virtual server
    appRuleIds List<String>
    List of attached application rule IDs
    connectionLimit Number
    Maximum concurrent connections that the virtual server can process
    connectionRateLimit Number
    Maximum incoming new connection requests per second
    description String
    Virtual server description
    edgeGateway String
    The name of the edge gateway on which the virtual server is to be created
    enableAcceleration Boolean
    Defines if the virtual server uses acceleration. Default false
    enabled Boolean
    Defines if the virtual server is enabled. Default true
    ipAddress String
    Set the IP address that the load balancer listens on
    lbVirtualServerId String
    The NSX ID of the load balancer virtual server
    name String
    Virtual server name
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    port Number
    The port number that the load balancer listens on
    protocol String
    Select the protocol that the virtual server accepts. One of tcp, udp, http, or https Note: You must select the same protocol used by the selected Application Profile
    serverPoolId String
    The server pool that the load balancer will use
    vdc String
    The name of VDC to use, optional if defined at provider level

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd