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

nsxt.LbSourceIpPersistenceProfile

Explore with Pulumi AI

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

    Create LbSourceIpPersistenceProfile Resource

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

    Constructor syntax

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

@overload
def LbSourceIpPersistenceProfile(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 description: Optional[str] = None,
                                 display_name: Optional[str] = None,
                                 ha_persistence_mirroring: Optional[bool] = None,
                                 lb_source_ip_persistence_profile_id: Optional[str] = None,
                                 persistence_shared: Optional[bool] = None,
                                 purge_when_full: Optional[bool] = None,
                                 tags: Optional[Sequence[LbSourceIpPersistenceProfileTagArgs]] = None,
                                 timeout: Optional[float] = None)
    func NewLbSourceIpPersistenceProfile(ctx *Context, name string, args *LbSourceIpPersistenceProfileArgs, opts ...ResourceOption) (*LbSourceIpPersistenceProfile, error)
    public LbSourceIpPersistenceProfile(string name, LbSourceIpPersistenceProfileArgs? args = null, CustomResourceOptions? opts = null)
    public LbSourceIpPersistenceProfile(String name, LbSourceIpPersistenceProfileArgs args)
public LbSourceIpPersistenceProfile(String name, LbSourceIpPersistenceProfileArgs args, CustomResourceOptions options)

    type: nsxt:LbSourceIpPersistenceProfile
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 LbSourceIpPersistenceProfileArgs
    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 LbSourceIpPersistenceProfileArgs
    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 LbSourceIpPersistenceProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbSourceIpPersistenceProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbSourceIpPersistenceProfileArgs
    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 lbSourceIpPersistenceProfileResource = new Nsxt.LbSourceIpPersistenceProfile("lbSourceIpPersistenceProfileResource", new()
{
    Description = "string",
    DisplayName = "string",
    HaPersistenceMirroring = false,
    LbSourceIpPersistenceProfileId = "string",
    PersistenceShared = false,
    PurgeWhenFull = false,
    Tags = new[]
    {
        new Nsxt.Inputs.LbSourceIpPersistenceProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Timeout = 0,
});

    example, err := nsxt.NewLbSourceIpPersistenceProfile(ctx, "lbSourceIpPersistenceProfileResource", &nsxt.LbSourceIpPersistenceProfileArgs{
	Description:                    pulumi.String("string"),
	DisplayName:                    pulumi.String("string"),
	HaPersistenceMirroring:         pulumi.Bool(false),
	LbSourceIpPersistenceProfileId: pulumi.String("string"),
	PersistenceShared:              pulumi.Bool(false),
	PurgeWhenFull:                  pulumi.Bool(false),
	Tags: nsxt.LbSourceIpPersistenceProfileTagArray{
		&nsxt.LbSourceIpPersistenceProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var lbSourceIpPersistenceProfileResource = new LbSourceIpPersistenceProfile("lbSourceIpPersistenceProfileResource", LbSourceIpPersistenceProfileArgs.builder()
    .description("string")
    .displayName("string")
    .haPersistenceMirroring(false)
    .lbSourceIpPersistenceProfileId("string")
    .persistenceShared(false)
    .purgeWhenFull(false)
    .tags(LbSourceIpPersistenceProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    lb_source_ip_persistence_profile_resource = nsxt.LbSourceIpPersistenceProfile("lbSourceIpPersistenceProfileResource",
    description="string",
    display_name="string",
    ha_persistence_mirroring=False,
    lb_source_ip_persistence_profile_id="string",
    persistence_shared=False,
    purge_when_full=False,
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const lbSourceIpPersistenceProfileResource = new nsxt.LbSourceIpPersistenceProfile("lbSourceIpPersistenceProfileResource", {
    description: "string",
    displayName: "string",
    haPersistenceMirroring: false,
    lbSourceIpPersistenceProfileId: "string",
    persistenceShared: false,
    purgeWhenFull: false,
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:LbSourceIpPersistenceProfile
properties:
    description: string
    displayName: string
    haPersistenceMirroring: false
    lbSourceIpPersistenceProfileId: string
    persistenceShared: false
    purgeWhenFull: false
    tags:
        - scope: string
          tag: string
    timeout: 0

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

    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    HaPersistenceMirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    LbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    PersistenceShared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    PurgeWhenFull bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    Tags List<LbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    Timeout double
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    HaPersistenceMirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    LbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    PersistenceShared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    PurgeWhenFull bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    Tags []LbSourceIpPersistenceProfileTagArgs
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    Timeout float64
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring Boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId String
    ID of the lb source ip persistence profile.
    persistenceShared Boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull Boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    tags List<LbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout Double
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    persistenceShared boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    tags LbSourceIpPersistenceProfileTag[]
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout number
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ha_persistence_mirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lb_source_ip_persistence_profile_id str
    ID of the lb source ip persistence profile.
    persistence_shared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purge_when_full bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    tags Sequence[LbSourceIpPersistenceProfileTagArgs]
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout float
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring Boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId String
    ID of the lb source ip persistence profile.
    persistenceShared Boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull Boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout Number
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LbSourceIpPersistenceProfile 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 LbSourceIpPersistenceProfile Resource

    Get an existing LbSourceIpPersistenceProfile 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?: LbSourceIpPersistenceProfileState, opts?: CustomResourceOptions): LbSourceIpPersistenceProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ha_persistence_mirroring: Optional[bool] = None,
        lb_source_ip_persistence_profile_id: Optional[str] = None,
        persistence_shared: Optional[bool] = None,
        purge_when_full: Optional[bool] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[LbSourceIpPersistenceProfileTagArgs]] = None,
        timeout: Optional[float] = None) -> LbSourceIpPersistenceProfile
    func GetLbSourceIpPersistenceProfile(ctx *Context, name string, id IDInput, state *LbSourceIpPersistenceProfileState, opts ...ResourceOption) (*LbSourceIpPersistenceProfile, error)
    public static LbSourceIpPersistenceProfile Get(string name, Input<string> id, LbSourceIpPersistenceProfileState? state, CustomResourceOptions? opts = null)
    public static LbSourceIpPersistenceProfile get(String name, Output<String> id, LbSourceIpPersistenceProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LbSourceIpPersistenceProfile    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.
    HaPersistenceMirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    LbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    PersistenceShared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    PurgeWhenFull bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<LbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    Timeout double
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    HaPersistenceMirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    LbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    PersistenceShared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    PurgeWhenFull bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []LbSourceIpPersistenceProfileTagArgs
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    Timeout float64
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring Boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId String
    ID of the lb source ip persistence profile.
    persistenceShared Boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull Boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<LbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout Double
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId string
    ID of the lb source ip persistence profile.
    persistenceShared boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags LbSourceIpPersistenceProfileTag[]
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout number
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ha_persistence_mirroring bool
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lb_source_ip_persistence_profile_id str
    ID of the lb source ip persistence profile.
    persistence_shared bool
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purge_when_full bool
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[LbSourceIpPersistenceProfileTagArgs]
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout float
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    haPersistenceMirroring Boolean
    A boolean flag which reflects whether persistence entries will be synchronized to the HA peer.
    lbSourceIpPersistenceProfileId String
    ID of the lb source ip persistence profile.
    persistenceShared Boolean
    A boolean flag which reflects whether the cookie persistence is private or shared.
    purgeWhenFull Boolean
    A boolean flag which reflects whether entries will be purged when the persistence table is full. Defaults to true.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    timeout Number
    Persistence expiration time in seconds, counted from the time all the connections are completed. Defaults to 300 seconds.

    Supporting Types

    LbSourceIpPersistenceProfileTag, LbSourceIpPersistenceProfileTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    scope string
    tag string
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    scope str
    tag str
    A list of scope + tag pairs to associate with this lb source ip persistence profile.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb source ip persistence profile.

    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