Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyLbService
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyLbService

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyLbService Resource

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

    Constructor syntax

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

@overload
def PolicyLbService(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    connectivity_path: Optional[str] = None,
                    description: Optional[str] = None,
                    enabled: Optional[bool] = None,
                    error_log_level: Optional[str] = None,
                    nsx_id: Optional[str] = None,
                    policy_lb_service_id: Optional[str] = None,
                    size: Optional[str] = None,
                    tags: Optional[Sequence[PolicyLbServiceTagArgs]] = None)
    func NewPolicyLbService(ctx *Context, name string, args PolicyLbServiceArgs, opts ...ResourceOption) (*PolicyLbService, error)
    public PolicyLbService(string name, PolicyLbServiceArgs args, CustomResourceOptions? opts = null)
    public PolicyLbService(String name, PolicyLbServiceArgs args)
public PolicyLbService(String name, PolicyLbServiceArgs args, CustomResourceOptions options)

    type: nsxt:PolicyLbService
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 PolicyLbServiceArgs
    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 PolicyLbServiceArgs
    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 PolicyLbServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyLbServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyLbServiceArgs
    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 policyLbServiceResource = new Nsxt.PolicyLbService("policyLbServiceResource", new()
{
    DisplayName = "string",
    ConnectivityPath = "string",
    Description = "string",
    Enabled = false,
    ErrorLogLevel = "string",
    NsxId = "string",
    PolicyLbServiceId = "string",
    Size = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyLbServiceTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyLbService(ctx, "policyLbServiceResource", &nsxt.PolicyLbServiceArgs{
	DisplayName:       pulumi.String("string"),
	ConnectivityPath:  pulumi.String("string"),
	Description:       pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	ErrorLogLevel:     pulumi.String("string"),
	NsxId:             pulumi.String("string"),
	PolicyLbServiceId: pulumi.String("string"),
	Size:              pulumi.String("string"),
	Tags: nsxt.PolicyLbServiceTagArray{
		&nsxt.PolicyLbServiceTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyLbServiceResource = new PolicyLbService("policyLbServiceResource", PolicyLbServiceArgs.builder()
    .displayName("string")
    .connectivityPath("string")
    .description("string")
    .enabled(false)
    .errorLogLevel("string")
    .nsxId("string")
    .policyLbServiceId("string")
    .size("string")
    .tags(PolicyLbServiceTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_lb_service_resource = nsxt.PolicyLbService("policyLbServiceResource",
    display_name="string",
    connectivity_path="string",
    description="string",
    enabled=False,
    error_log_level="string",
    nsx_id="string",
    policy_lb_service_id="string",
    size="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyLbServiceResource = new nsxt.PolicyLbService("policyLbServiceResource", {
    displayName: "string",
    connectivityPath: "string",
    description: "string",
    enabled: false,
    errorLogLevel: "string",
    nsxId: "string",
    policyLbServiceId: "string",
    size: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyLbService
properties:
    connectivityPath: string
    description: string
    displayName: string
    enabled: false
    errorLogLevel: string
    nsxId: string
    policyLbServiceId: string
    size: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    ConnectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    Description string
    Description of the resource.
    Enabled bool
    Flag to enable the service.
    ErrorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbServiceId string
    ID of the resource.
    Size string
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    Tags List<PolicyLbServiceTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    ConnectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    Description string
    Description of the resource.
    Enabled bool
    Flag to enable the service.
    ErrorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbServiceId string
    ID of the resource.
    Size string
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    Tags []PolicyLbServiceTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    connectivityPath String
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description String
    Description of the resource.
    enabled Boolean
    Flag to enable the service.
    errorLogLevel String
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbServiceId String
    ID of the resource.
    size String
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags List<PolicyLbServiceTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    connectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description string
    Description of the resource.
    enabled boolean
    Flag to enable the service.
    errorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbServiceId string
    ID of the resource.
    size string
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags PolicyLbServiceTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    connectivity_path str
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description str
    Description of the resource.
    enabled bool
    Flag to enable the service.
    error_log_level str
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_lb_service_id str
    ID of the resource.
    size str
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags Sequence[PolicyLbServiceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    connectivityPath String
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description String
    Description of the resource.
    enabled Boolean
    Flag to enable the service.
    errorLogLevel String
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbServiceId String
    ID of the resource.
    size String
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy 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.
    Path string
    The NSX path of the policy 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.
    path String
    The NSX path of the policy 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.
    path string
    The NSX path of the policy 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.
    path str
    The NSX path of the policy 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.
    path String
    The NSX path of the policy 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 PolicyLbService Resource

    Get an existing PolicyLbService 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?: PolicyLbServiceState, opts?: CustomResourceOptions): PolicyLbService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connectivity_path: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        error_log_level: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_lb_service_id: Optional[str] = None,
        revision: Optional[float] = None,
        size: Optional[str] = None,
        tags: Optional[Sequence[PolicyLbServiceTagArgs]] = None) -> PolicyLbService
    func GetPolicyLbService(ctx *Context, name string, id IDInput, state *PolicyLbServiceState, opts ...ResourceOption) (*PolicyLbService, error)
    public static PolicyLbService Get(string name, Input<string> id, PolicyLbServiceState? state, CustomResourceOptions? opts = null)
    public static PolicyLbService get(String name, Output<String> id, PolicyLbServiceState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbService    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:
    ConnectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    Enabled bool
    Flag to enable the service.
    ErrorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyLbServiceId string
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    Tags List<PolicyLbServiceTag>
    A list of scope + tag pairs to associate with this resource.
    ConnectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    Enabled bool
    Flag to enable the service.
    ErrorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyLbServiceId string
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    Tags []PolicyLbServiceTagArgs
    A list of scope + tag pairs to associate with this resource.
    connectivityPath String
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    enabled Boolean
    Flag to enable the service.
    errorLogLevel String
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyLbServiceId String
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags List<PolicyLbServiceTag>
    A list of scope + tag pairs to associate with this resource.
    connectivityPath string
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    enabled boolean
    Flag to enable the service.
    errorLogLevel string
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    policyLbServiceId string
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags PolicyLbServiceTag[]
    A list of scope + tag pairs to associate with this resource.
    connectivity_path str
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    enabled bool
    Flag to enable the service.
    error_log_level str
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    policy_lb_service_id str
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags Sequence[PolicyLbServiceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    connectivityPath String
    Tier1 Gateway where this service is instantiated. In future, other objects will be supported.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    enabled Boolean
    Flag to enable the service.
    errorLogLevel String
    Log level for the service, one of DEBUG, INFO, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Default is INFO.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyLbServiceId String
    ID of the resource.
    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
    Load Balancer Service size, one of SMALL, MEDIUM, LARGE, XLARGE, DLB. Default is SMALL. Please note that XLARGE is only supported since NSX 3.0.0
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyLbServiceTag, PolicyLbServiceTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

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