1. Packages
  2. Nsxt Provider
  3. API Docs
  4. LbPassiveMonitor
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.LbPassiveMonitor

Explore with Pulumi AI

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

    Create LbPassiveMonitor Resource

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

    Constructor syntax

    new LbPassiveMonitor(name: string, args?: LbPassiveMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def LbPassiveMonitor(resource_name: str,
                         args: Optional[LbPassiveMonitorArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def LbPassiveMonitor(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         display_name: Optional[str] = None,
                         lb_passive_monitor_id: Optional[str] = None,
                         max_fails: Optional[float] = None,
                         tags: Optional[Sequence[LbPassiveMonitorTagArgs]] = None,
                         timeout: Optional[float] = None)
    func NewLbPassiveMonitor(ctx *Context, name string, args *LbPassiveMonitorArgs, opts ...ResourceOption) (*LbPassiveMonitor, error)
    public LbPassiveMonitor(string name, LbPassiveMonitorArgs? args = null, CustomResourceOptions? opts = null)
    public LbPassiveMonitor(String name, LbPassiveMonitorArgs args)
    public LbPassiveMonitor(String name, LbPassiveMonitorArgs args, CustomResourceOptions options)
    
    type: nsxt:LbPassiveMonitor
    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 LbPassiveMonitorArgs
    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 LbPassiveMonitorArgs
    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 LbPassiveMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbPassiveMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbPassiveMonitorArgs
    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 lbPassiveMonitorResource = new Nsxt.LbPassiveMonitor("lbPassiveMonitorResource", new()
    {
        Description = "string",
        DisplayName = "string",
        LbPassiveMonitorId = "string",
        MaxFails = 0,
        Tags = new[]
        {
            new Nsxt.Inputs.LbPassiveMonitorTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        Timeout = 0,
    });
    
    example, err := nsxt.NewLbPassiveMonitor(ctx, "lbPassiveMonitorResource", &nsxt.LbPassiveMonitorArgs{
    	Description:        pulumi.String("string"),
    	DisplayName:        pulumi.String("string"),
    	LbPassiveMonitorId: pulumi.String("string"),
    	MaxFails:           pulumi.Float64(0),
    	Tags: nsxt.LbPassiveMonitorTagArray{
    		&nsxt.LbPassiveMonitorTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	Timeout: pulumi.Float64(0),
    })
    
    var lbPassiveMonitorResource = new LbPassiveMonitor("lbPassiveMonitorResource", LbPassiveMonitorArgs.builder()
        .description("string")
        .displayName("string")
        .lbPassiveMonitorId("string")
        .maxFails(0)
        .tags(LbPassiveMonitorTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .timeout(0)
        .build());
    
    lb_passive_monitor_resource = nsxt.LbPassiveMonitor("lbPassiveMonitorResource",
        description="string",
        display_name="string",
        lb_passive_monitor_id="string",
        max_fails=0,
        tags=[{
            "scope": "string",
            "tag": "string",
        }],
        timeout=0)
    
    const lbPassiveMonitorResource = new nsxt.LbPassiveMonitor("lbPassiveMonitorResource", {
        description: "string",
        displayName: "string",
        lbPassiveMonitorId: "string",
        maxFails: 0,
        tags: [{
            scope: "string",
            tag: "string",
        }],
        timeout: 0,
    });
    
    type: nsxt:LbPassiveMonitor
    properties:
        description: string
        displayName: string
        lbPassiveMonitorId: string
        maxFails: 0
        tags:
            - scope: string
              tag: string
        timeout: 0
    

    LbPassiveMonitor 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 LbPassiveMonitor 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.
    LbPassiveMonitorId string
    ID of the lb_passive_monitor.
    MaxFails double
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    Tags List<LbPassiveMonitorTag>
    A list of scope + tag pairs to associate with this lb passive monitor.
    Timeout double
    After this timeout period, the member is probed again.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    LbPassiveMonitorId string
    ID of the lb_passive_monitor.
    MaxFails float64
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    Tags []LbPassiveMonitorTagArgs
    A list of scope + tag pairs to associate with this lb passive monitor.
    Timeout float64
    After this timeout period, the member is probed again.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId String
    ID of the lb_passive_monitor.
    maxFails Double
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    tags List<LbPassiveMonitorTag>
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout Double
    After this timeout period, the member is probed again.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId string
    ID of the lb_passive_monitor.
    maxFails number
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    tags LbPassiveMonitorTag[]
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout number
    After this timeout period, the member is probed again.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    lb_passive_monitor_id str
    ID of the lb_passive_monitor.
    max_fails float
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    tags Sequence[LbPassiveMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout float
    After this timeout period, the member is probed again.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId String
    ID of the lb_passive_monitor.
    maxFails Number
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout Number
    After this timeout period, the member is probed again.

    Outputs

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

    Get an existing LbPassiveMonitor 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?: LbPassiveMonitorState, opts?: CustomResourceOptions): LbPassiveMonitor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            lb_passive_monitor_id: Optional[str] = None,
            max_fails: Optional[float] = None,
            revision: Optional[float] = None,
            tags: Optional[Sequence[LbPassiveMonitorTagArgs]] = None,
            timeout: Optional[float] = None) -> LbPassiveMonitor
    func GetLbPassiveMonitor(ctx *Context, name string, id IDInput, state *LbPassiveMonitorState, opts ...ResourceOption) (*LbPassiveMonitor, error)
    public static LbPassiveMonitor Get(string name, Input<string> id, LbPassiveMonitorState? state, CustomResourceOptions? opts = null)
    public static LbPassiveMonitor get(String name, Output<String> id, LbPassiveMonitorState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LbPassiveMonitor    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.
    LbPassiveMonitorId string
    ID of the lb_passive_monitor.
    MaxFails double
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    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<LbPassiveMonitorTag>
    A list of scope + tag pairs to associate with this lb passive monitor.
    Timeout double
    After this timeout period, the member is probed again.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    LbPassiveMonitorId string
    ID of the lb_passive_monitor.
    MaxFails float64
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []LbPassiveMonitorTagArgs
    A list of scope + tag pairs to associate with this lb passive monitor.
    Timeout float64
    After this timeout period, the member is probed again.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId String
    ID of the lb_passive_monitor.
    maxFails Double
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    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<LbPassiveMonitorTag>
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout Double
    After this timeout period, the member is probed again.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId string
    ID of the lb_passive_monitor.
    maxFails number
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags LbPassiveMonitorTag[]
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout number
    After this timeout period, the member is probed again.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    lb_passive_monitor_id str
    ID of the lb_passive_monitor.
    max_fails float
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    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[LbPassiveMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb passive monitor.
    timeout float
    After this timeout period, the member is probed again.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    lbPassiveMonitorId String
    ID of the lb_passive_monitor.
    maxFails Number
    When consecutive failures reach this value, the member is considered temporarily unavailable for a configurable period.
    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 passive monitor.
    timeout Number
    After this timeout period, the member is probed again.

    Supporting Types

    LbPassiveMonitorTag, LbPassiveMonitorTagArgs

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

    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