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

nsxt.PolicyLbSourceIpPersistenceProfile

Explore with Pulumi AI

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

    Create PolicyLbSourceIpPersistenceProfile Resource

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

    Constructor syntax

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

@overload
def PolicyLbSourceIpPersistenceProfile(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       display_name: Optional[str] = None,
                                       description: Optional[str] = None,
                                       ha_persistence_mirroring_enabled: Optional[bool] = None,
                                       nsx_id: Optional[str] = None,
                                       persistence_shared: Optional[bool] = None,
                                       policy_lb_source_ip_persistence_profile_id: Optional[str] = None,
                                       purge: Optional[str] = None,
                                       tags: Optional[Sequence[PolicyLbSourceIpPersistenceProfileTagArgs]] = None,
                                       timeout: Optional[float] = None)
    func NewPolicyLbSourceIpPersistenceProfile(ctx *Context, name string, args PolicyLbSourceIpPersistenceProfileArgs, opts ...ResourceOption) (*PolicyLbSourceIpPersistenceProfile, error)
    public PolicyLbSourceIpPersistenceProfile(string name, PolicyLbSourceIpPersistenceProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyLbSourceIpPersistenceProfile(String name, PolicyLbSourceIpPersistenceProfileArgs args)
public PolicyLbSourceIpPersistenceProfile(String name, PolicyLbSourceIpPersistenceProfileArgs args, CustomResourceOptions options)

    type: nsxt:PolicyLbSourceIpPersistenceProfile
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 PolicyLbSourceIpPersistenceProfileArgs
    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 PolicyLbSourceIpPersistenceProfileArgs
    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 PolicyLbSourceIpPersistenceProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyLbSourceIpPersistenceProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyLbSourceIpPersistenceProfileArgs
    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 policyLbSourceIpPersistenceProfileResource = new Nsxt.PolicyLbSourceIpPersistenceProfile("policyLbSourceIpPersistenceProfileResource", new()
{
    DisplayName = "string",
    Description = "string",
    HaPersistenceMirroringEnabled = false,
    NsxId = "string",
    PersistenceShared = false,
    PolicyLbSourceIpPersistenceProfileId = "string",
    Purge = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyLbSourceIpPersistenceProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Timeout = 0,
});

    example, err := nsxt.NewPolicyLbSourceIpPersistenceProfile(ctx, "policyLbSourceIpPersistenceProfileResource", &nsxt.PolicyLbSourceIpPersistenceProfileArgs{
	DisplayName:                          pulumi.String("string"),
	Description:                          pulumi.String("string"),
	HaPersistenceMirroringEnabled:        pulumi.Bool(false),
	NsxId:                                pulumi.String("string"),
	PersistenceShared:                    pulumi.Bool(false),
	PolicyLbSourceIpPersistenceProfileId: pulumi.String("string"),
	Purge:                                pulumi.String("string"),
	Tags: nsxt.PolicyLbSourceIpPersistenceProfileTagArray{
		&nsxt.PolicyLbSourceIpPersistenceProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var policyLbSourceIpPersistenceProfileResource = new PolicyLbSourceIpPersistenceProfile("policyLbSourceIpPersistenceProfileResource", PolicyLbSourceIpPersistenceProfileArgs.builder()
    .displayName("string")
    .description("string")
    .haPersistenceMirroringEnabled(false)
    .nsxId("string")
    .persistenceShared(false)
    .policyLbSourceIpPersistenceProfileId("string")
    .purge("string")
    .tags(PolicyLbSourceIpPersistenceProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    policy_lb_source_ip_persistence_profile_resource = nsxt.PolicyLbSourceIpPersistenceProfile("policyLbSourceIpPersistenceProfileResource",
    display_name="string",
    description="string",
    ha_persistence_mirroring_enabled=False,
    nsx_id="string",
    persistence_shared=False,
    policy_lb_source_ip_persistence_profile_id="string",
    purge="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const policyLbSourceIpPersistenceProfileResource = new nsxt.PolicyLbSourceIpPersistenceProfile("policyLbSourceIpPersistenceProfileResource", {
    displayName: "string",
    description: "string",
    haPersistenceMirroringEnabled: false,
    nsxId: "string",
    persistenceShared: false,
    policyLbSourceIpPersistenceProfileId: "string",
    purge: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:PolicyLbSourceIpPersistenceProfile
properties:
    description: string
    displayName: string
    haPersistenceMirroringEnabled: false
    nsxId: string
    persistenceShared: false
    policyLbSourceIpPersistenceProfileId: string
    purge: string
    tags:
        - scope: string
          tag: string
    timeout: 0

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

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    HaPersistenceMirroringEnabled bool
    If enabled, persistence entries are syncronized to HA peer.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PersistenceShared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    PolicyLbSourceIpPersistenceProfileId string
    ID of the resource.
    Purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    Tags List<PolicyLbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Expiration time once all connections are complete. Default is 300.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    HaPersistenceMirroringEnabled bool
    If enabled, persistence entries are syncronized to HA peer.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PersistenceShared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    PolicyLbSourceIpPersistenceProfileId string
    ID of the resource.
    Purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    Tags []PolicyLbSourceIpPersistenceProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Expiration time once all connections are complete. Default is 300.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    haPersistenceMirroringEnabled Boolean
    If enabled, persistence entries are syncronized to HA peer.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    persistenceShared Boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId String
    ID of the resource.
    purge String
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    tags List<PolicyLbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Expiration time once all connections are complete. Default is 300.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    haPersistenceMirroringEnabled boolean
    If enabled, persistence entries are syncronized to HA peer.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    persistenceShared boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId string
    ID of the resource.
    purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    tags PolicyLbSourceIpPersistenceProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Expiration time once all connections are complete. Default is 300.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    ha_persistence_mirroring_enabled bool
    If enabled, persistence entries are syncronized to HA peer.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    persistence_shared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policy_lb_source_ip_persistence_profile_id str
    ID of the resource.
    purge str
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    tags Sequence[PolicyLbSourceIpPersistenceProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Expiration time once all connections are complete. Default is 300.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    haPersistenceMirroringEnabled Boolean
    If enabled, persistence entries are syncronized to HA peer.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    persistenceShared Boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId String
    ID of the resource.
    purge String
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Expiration time once all connections are complete. Default is 300.

    Outputs

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

    Get an existing PolicyLbSourceIpPersistenceProfile 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?: PolicyLbSourceIpPersistenceProfileState, opts?: CustomResourceOptions): PolicyLbSourceIpPersistenceProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ha_persistence_mirroring_enabled: Optional[bool] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        persistence_shared: Optional[bool] = None,
        policy_lb_source_ip_persistence_profile_id: Optional[str] = None,
        purge: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyLbSourceIpPersistenceProfileTagArgs]] = None,
        timeout: Optional[float] = None) -> PolicyLbSourceIpPersistenceProfile
    func GetPolicyLbSourceIpPersistenceProfile(ctx *Context, name string, id IDInput, state *PolicyLbSourceIpPersistenceProfileState, opts ...ResourceOption) (*PolicyLbSourceIpPersistenceProfile, error)
    public static PolicyLbSourceIpPersistenceProfile Get(string name, Input<string> id, PolicyLbSourceIpPersistenceProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyLbSourceIpPersistenceProfile get(String name, Output<String> id, PolicyLbSourceIpPersistenceProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbSourceIpPersistenceProfile    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 the resource.
    DisplayName string
    Display name of the resource.
    HaPersistenceMirroringEnabled bool
    If enabled, persistence entries are syncronized to HA peer.
    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.
    PersistenceShared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    PolicyLbSourceIpPersistenceProfileId string
    ID of the resource.
    Purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    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<PolicyLbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Expiration time once all connections are complete. Default is 300.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    HaPersistenceMirroringEnabled bool
    If enabled, persistence entries are syncronized to HA peer.
    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.
    PersistenceShared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    PolicyLbSourceIpPersistenceProfileId string
    ID of the resource.
    Purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyLbSourceIpPersistenceProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Expiration time once all connections are complete. Default is 300.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    haPersistenceMirroringEnabled Boolean
    If enabled, persistence entries are syncronized to HA peer.
    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.
    persistenceShared Boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId String
    ID of the resource.
    purge String
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    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<PolicyLbSourceIpPersistenceProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Expiration time once all connections are complete. Default is 300.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    haPersistenceMirroringEnabled boolean
    If enabled, persistence entries are syncronized to HA peer.
    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.
    persistenceShared boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId string
    ID of the resource.
    purge string
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyLbSourceIpPersistenceProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Expiration time once all connections are complete. Default is 300.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    ha_persistence_mirroring_enabled bool
    If enabled, persistence entries are syncronized to HA peer.
    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.
    persistence_shared bool
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policy_lb_source_ip_persistence_profile_id str
    ID of the resource.
    purge str
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    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[PolicyLbSourceIpPersistenceProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Expiration time once all connections are complete. Default is 300.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    haPersistenceMirroringEnabled Boolean
    If enabled, persistence entries are syncronized to HA peer.
    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.
    persistenceShared Boolean
    If enabled, all virtual servers with this profile will share the same persistence mechanism.
    policyLbSourceIpPersistenceProfileId String
    ID of the resource.
    purge String
    Persistence purge setting, either NO_PURGE or FULL. Default is FULL.
    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 resource.
    timeout Number
    Expiration time once all connections are complete. Default is 300.

    Supporting Types

    PolicyLbSourceIpPersistenceProfileTag, PolicyLbSourceIpPersistenceProfileTagArgs

    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