nsxt 3.8.1, Apr 30 25

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.LbService

Explore with Pulumi AI

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

Create LbService Resource

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

Constructor syntax

new LbService(name: string, args: LbServiceArgs, opts?: CustomResourceOptions);

@overload
def LbService(resource_name: str,
              args: LbServiceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def LbService(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              logical_router_id: Optional[str] = None,
              description: Optional[str] = None,
              display_name: Optional[str] = None,
              enabled: Optional[bool] = None,
              error_log_level: Optional[str] = None,
              lb_service_id: Optional[str] = None,
              size: Optional[str] = None,
              tags: Optional[Sequence[LbServiceTagArgs]] = None,
              virtual_server_ids: Optional[Sequence[str]] = None)

func NewLbService(ctx *Context, name string, args LbServiceArgs, opts ...ResourceOption) (*LbService, error)

public LbService(string name, LbServiceArgs args, CustomResourceOptions? opts = null)

public LbService(String name, LbServiceArgs args)
public LbService(String name, LbServiceArgs args, CustomResourceOptions options)

type: nsxt:LbService
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 LbServiceArgs: 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 LbServiceArgs: 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 LbServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LbServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LbServiceArgs: 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 lbServiceResource = new Nsxt.LbService("lbServiceResource", new()
{
    LogicalRouterId = "string",
    Description = "string",
    DisplayName = "string",
    Enabled = false,
    ErrorLogLevel = "string",
    LbServiceId = "string",
    Size = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.LbServiceTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    VirtualServerIds = new[]
    {
        "string",
    },
});

example, err := nsxt.NewLbService(ctx, "lbServiceResource", &nsxt.LbServiceArgs{
	LogicalRouterId: pulumi.String("string"),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	Enabled:         pulumi.Bool(false),
	ErrorLogLevel:   pulumi.String("string"),
	LbServiceId:     pulumi.String("string"),
	Size:            pulumi.String("string"),
	Tags: nsxt.LbServiceTagArray{
		&nsxt.LbServiceTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	VirtualServerIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var lbServiceResource = new LbService("lbServiceResource", LbServiceArgs.builder()
    .logicalRouterId("string")
    .description("string")
    .displayName("string")
    .enabled(false)
    .errorLogLevel("string")
    .lbServiceId("string")
    .size("string")
    .tags(LbServiceTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .virtualServerIds("string")
    .build());

lb_service_resource = nsxt.LbService("lbServiceResource",
    logical_router_id="string",
    description="string",
    display_name="string",
    enabled=False,
    error_log_level="string",
    lb_service_id="string",
    size="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    virtual_server_ids=["string"])

const lbServiceResource = new nsxt.LbService("lbServiceResource", {
    logicalRouterId: "string",
    description: "string",
    displayName: "string",
    enabled: false,
    errorLogLevel: "string",
    lbServiceId: "string",
    size: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    virtualServerIds: ["string"],
});

type: nsxt:LbService
properties:
    description: string
    displayName: string
    enabled: false
    errorLogLevel: string
    lbServiceId: string
    logicalRouterId: string
    size: string
    tags:
        - scope: string
          tag: string
    virtualServerIds:
        - string

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

LogicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
Enabled bool: whether the load balancer service is enabled.
ErrorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
LbServiceId string: ID of the lb_service.
Size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
Tags List<LbServiceTag>: A list of scope + tag pairs to associate with this lb service.
VirtualServerIds List<string>: Virtual servers associated with this Load Balancer.

LogicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
Enabled bool: whether the load balancer service is enabled.
ErrorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
LbServiceId string: ID of the lb_service.
Size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
Tags []LbServiceTagArgs: A list of scope + tag pairs to associate with this lb service.
VirtualServerIds []string: Virtual servers associated with this Load Balancer.

logicalRouterId String: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
enabled Boolean: whether the load balancer service is enabled.
errorLogLevel String: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId String: ID of the lb_service.
size String: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags List<LbServiceTag>: A list of scope + tag pairs to associate with this lb service.
virtualServerIds List<String>: Virtual servers associated with this Load Balancer.

logicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
description string: Description of this resource.
displayName string: The display name of this resource. Defaults to ID if not set.
enabled boolean: whether the load balancer service is enabled.
errorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId string: ID of the lb_service.
size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags LbServiceTag[]: A list of scope + tag pairs to associate with this lb service.
virtualServerIds string[]: Virtual servers associated with this Load Balancer.

logical_router_id str: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
description str: Description of this resource.
display_name str: The display name of this resource. Defaults to ID if not set.
enabled bool: whether the load balancer service is enabled.
error_log_level str: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lb_service_id str: ID of the lb_service.
size str: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags Sequence[LbServiceTagArgs]: A list of scope + tag pairs to associate with this lb service.
virtual_server_ids Sequence[str]: Virtual servers associated with this Load Balancer.

logicalRouterId String: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
enabled Boolean: whether the load balancer service is enabled.
errorLogLevel String: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId String: ID of the lb_service.
size String: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags List<Property Map>: A list of scope + tag pairs to associate with this lb service.
virtualServerIds List<String>: Virtual servers associated with this Load Balancer.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Revision double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Id string: The provider-assigned unique ID for this managed resource.
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

id String: The provider-assigned unique ID for this managed resource.
revision Double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

id string: The provider-assigned unique ID for this managed resource.
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

id str: The provider-assigned unique ID for this managed resource.
revision float: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

id String: The provider-assigned unique ID for this managed resource.
revision Number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing LbService Resource

Get an existing LbService 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?: LbServiceState, opts?: CustomResourceOptions): LbService

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        error_log_level: Optional[str] = None,
        lb_service_id: Optional[str] = None,
        logical_router_id: Optional[str] = None,
        revision: Optional[float] = None,
        size: Optional[str] = None,
        tags: Optional[Sequence[LbServiceTagArgs]] = None,
        virtual_server_ids: Optional[Sequence[str]] = None) -> LbService

func GetLbService(ctx *Context, name string, id IDInput, state *LbServiceState, opts ...ResourceOption) (*LbService, error)

public static LbService Get(string name, Input<string> id, LbServiceState? state, CustomResourceOptions? opts = null)

public static LbService get(String name, Output<String> id, LbServiceState state, CustomResourceOptions options)

resources:  _:    type: nsxt:LbService    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:

Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
Enabled bool: whether the load balancer service is enabled.
ErrorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
LbServiceId string: ID of the lb_service.
LogicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
Revision double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
Tags List<LbServiceTag>: A list of scope + tag pairs to associate with this lb service.
VirtualServerIds List<string>: Virtual servers associated with this Load Balancer.

Description string: Description of this resource.
DisplayName string: The display name of this resource. Defaults to ID if not set.
Enabled bool: whether the load balancer service is enabled.
ErrorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
LbServiceId string: ID of the lb_service.
LogicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
Tags []LbServiceTagArgs: A list of scope + tag pairs to associate with this lb service.
VirtualServerIds []string: Virtual servers associated with this Load Balancer.

description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
enabled Boolean: whether the load balancer service is enabled.
errorLogLevel String: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId String: ID of the lb_service.
logicalRouterId String: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
revision Double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
size String: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags List<LbServiceTag>: A list of scope + tag pairs to associate with this lb service.
virtualServerIds List<String>: Virtual servers associated with this Load Balancer.

description string: Description of this resource.
displayName string: The display name of this resource. Defaults to ID if not set.
enabled boolean: whether the load balancer service is enabled.
errorLogLevel string: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId string: ID of the lb_service.
logicalRouterId string: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
size string: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags LbServiceTag[]: A list of scope + tag pairs to associate with this lb service.
virtualServerIds string[]: Virtual servers associated with this Load Balancer.

description str: Description of this resource.
display_name str: The display name of this resource. Defaults to ID if not set.
enabled bool: whether the load balancer service is enabled.
error_log_level str: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lb_service_id str: ID of the lb_service.
logical_router_id str: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
revision float: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
size str: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags Sequence[LbServiceTagArgs]: A list of scope + tag pairs to associate with this lb service.
virtual_server_ids Sequence[str]: Virtual servers associated with this Load Balancer.

description String: Description of this resource.
displayName String: The display name of this resource. Defaults to ID if not set.
enabled Boolean: whether the load balancer service is enabled.
errorLogLevel String: Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.
lbServiceId String: ID of the lb_service.
logicalRouterId String: Tier1 logical router this service is attached to. Note that this router needs to have edge cluster configured, and have an uplink port or CSP (centralized service port).
revision Number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
size String: Size of load balancer service. Accepted values are SMALL/MEDIUM/LARGE.
tags List<Property Map>: A list of scope + tag pairs to associate with this lb service.
virtualServerIds List<String>: Virtual servers associated with this Load Balancer.

Supporting Types

LbServiceTag, LbServiceTagArgs

Scope string
Tag string: A list of scope + tag pairs to associate with this lb service.

Scope string
Tag string: A list of scope + tag pairs to associate with this lb service.

scope String
tag String: A list of scope + tag pairs to associate with this lb service.

scope string
tag string: A list of scope + tag pairs to associate with this lb service.

scope str
tag str: A list of scope + tag pairs to associate with this lb service.

scope String
tag String: A list of scope + tag pairs to associate with this lb service.

Package Details

Repository: nsxt vmware/terraform-provider-nsxt
License
Notes: This Pulumi package is based on the nsxt Terraform Provider.

nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

vmware/terraform-provider-nsxt

nsxt.LbService

On this page

On this page

Create LbService Resource

Constructor syntax

Parameters

Constructor example

LbService Resource Properties

Inputs

Outputs

Look up Existing LbService Resource

Supporting Types

LbServiceTag, LbServiceTagArgs

Package Details

On this page

On this page