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

nsxt.LbIcmpMonitor

Explore with Pulumi AI

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

    Create LbIcmpMonitor Resource

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

    Constructor syntax

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

@overload
def LbIcmpMonitor(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  data_length: Optional[float] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  fall_count: Optional[float] = None,
                  interval: Optional[float] = None,
                  lb_icmp_monitor_id: Optional[str] = None,
                  monitor_port: Optional[str] = None,
                  rise_count: Optional[float] = None,
                  tags: Optional[Sequence[LbIcmpMonitorTagArgs]] = None,
                  timeout: Optional[float] = None)
    func NewLbIcmpMonitor(ctx *Context, name string, args *LbIcmpMonitorArgs, opts ...ResourceOption) (*LbIcmpMonitor, error)
    public LbIcmpMonitor(string name, LbIcmpMonitorArgs? args = null, CustomResourceOptions? opts = null)
    public LbIcmpMonitor(String name, LbIcmpMonitorArgs args)
public LbIcmpMonitor(String name, LbIcmpMonitorArgs args, CustomResourceOptions options)

    type: nsxt:LbIcmpMonitor
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 LbIcmpMonitorArgs
    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 LbIcmpMonitorArgs
    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 LbIcmpMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbIcmpMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbIcmpMonitorArgs
    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 lbIcmpMonitorResource = new Nsxt.LbIcmpMonitor("lbIcmpMonitorResource", new()
{
    DataLength = 0,
    Description = "string",
    DisplayName = "string",
    FallCount = 0,
    Interval = 0,
    LbIcmpMonitorId = "string",
    MonitorPort = "string",
    RiseCount = 0,
    Tags = new[]
    {
        new Nsxt.Inputs.LbIcmpMonitorTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Timeout = 0,
});

    example, err := nsxt.NewLbIcmpMonitor(ctx, "lbIcmpMonitorResource", &nsxt.LbIcmpMonitorArgs{
	DataLength:      pulumi.Float64(0),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	FallCount:       pulumi.Float64(0),
	Interval:        pulumi.Float64(0),
	LbIcmpMonitorId: pulumi.String("string"),
	MonitorPort:     pulumi.String("string"),
	RiseCount:       pulumi.Float64(0),
	Tags: nsxt.LbIcmpMonitorTagArray{
		&nsxt.LbIcmpMonitorTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var lbIcmpMonitorResource = new LbIcmpMonitor("lbIcmpMonitorResource", LbIcmpMonitorArgs.builder()
    .dataLength(0)
    .description("string")
    .displayName("string")
    .fallCount(0)
    .interval(0)
    .lbIcmpMonitorId("string")
    .monitorPort("string")
    .riseCount(0)
    .tags(LbIcmpMonitorTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    lb_icmp_monitor_resource = nsxt.LbIcmpMonitor("lbIcmpMonitorResource",
    data_length=0,
    description="string",
    display_name="string",
    fall_count=0,
    interval=0,
    lb_icmp_monitor_id="string",
    monitor_port="string",
    rise_count=0,
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const lbIcmpMonitorResource = new nsxt.LbIcmpMonitor("lbIcmpMonitorResource", {
    dataLength: 0,
    description: "string",
    displayName: "string",
    fallCount: 0,
    interval: 0,
    lbIcmpMonitorId: "string",
    monitorPort: "string",
    riseCount: 0,
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:LbIcmpMonitor
properties:
    dataLength: 0
    description: string
    displayName: string
    fallCount: 0
    interval: 0
    lbIcmpMonitorId: string
    monitorPort: string
    riseCount: 0
    tags:
        - scope: string
          tag: string
    timeout: 0

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

    DataLength double
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    FallCount double
    Number of consecutive checks must fail before marking it down.
    Interval double
    The frequency at which the system issues the monitor check (in seconds).
    LbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    RiseCount double
    Number of consecutive checks must pass before marking it up.
    Tags List<LbIcmpMonitorTag>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    Timeout double
    Number of seconds the target has in which to respond to the monitor request.
    DataLength float64
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    FallCount float64
    Number of consecutive checks must fail before marking it down.
    Interval float64
    The frequency at which the system issues the monitor check (in seconds).
    LbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    RiseCount float64
    Number of consecutive checks must pass before marking it up.
    Tags []LbIcmpMonitorTagArgs
    A list of scope + tag pairs to associate with this lb icmp monitor.
    Timeout float64
    Number of seconds the target has in which to respond to the monitor request.
    dataLength Double
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    fallCount Double
    Number of consecutive checks must fail before marking it down.
    interval Double
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId String
    ID of the lb_icmp_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    riseCount Double
    Number of consecutive checks must pass before marking it up.
    tags List<LbIcmpMonitorTag>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout Double
    Number of seconds the target has in which to respond to the monitor request.
    dataLength number
    The data size (in bytes) of the ICMP healthcheck packet.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    fallCount number
    Number of consecutive checks must fail before marking it down.
    interval number
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    monitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    riseCount number
    Number of consecutive checks must pass before marking it up.
    tags LbIcmpMonitorTag[]
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout number
    Number of seconds the target has in which to respond to the monitor request.
    data_length float
    The data size (in bytes) of the ICMP healthcheck packet.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    fall_count float
    Number of consecutive checks must fail before marking it down.
    interval float
    The frequency at which the system issues the monitor check (in seconds).
    lb_icmp_monitor_id str
    ID of the lb_icmp_monitor.
    monitor_port str
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    rise_count float
    Number of consecutive checks must pass before marking it up.
    tags Sequence[LbIcmpMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout float
    Number of seconds the target has in which to respond to the monitor request.
    dataLength Number
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    fallCount Number
    Number of consecutive checks must fail before marking it down.
    interval Number
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId String
    ID of the lb_icmp_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    riseCount Number
    Number of consecutive checks must pass before marking it up.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout Number
    Number of seconds the target has in which to respond to the monitor request.

    Outputs

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

    Get an existing LbIcmpMonitor 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?: LbIcmpMonitorState, opts?: CustomResourceOptions): LbIcmpMonitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_length: Optional[float] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        fall_count: Optional[float] = None,
        interval: Optional[float] = None,
        lb_icmp_monitor_id: Optional[str] = None,
        monitor_port: Optional[str] = None,
        revision: Optional[float] = None,
        rise_count: Optional[float] = None,
        tags: Optional[Sequence[LbIcmpMonitorTagArgs]] = None,
        timeout: Optional[float] = None) -> LbIcmpMonitor
    func GetLbIcmpMonitor(ctx *Context, name string, id IDInput, state *LbIcmpMonitorState, opts ...ResourceOption) (*LbIcmpMonitor, error)
    public static LbIcmpMonitor Get(string name, Input<string> id, LbIcmpMonitorState? state, CustomResourceOptions? opts = null)
    public static LbIcmpMonitor get(String name, Output<String> id, LbIcmpMonitorState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LbIcmpMonitor    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:
    DataLength double
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    FallCount double
    Number of consecutive checks must fail before marking it down.
    Interval double
    The frequency at which the system issues the monitor check (in seconds).
    LbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RiseCount double
    Number of consecutive checks must pass before marking it up.
    Tags List<LbIcmpMonitorTag>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    Timeout double
    Number of seconds the target has in which to respond to the monitor request.
    DataLength float64
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    FallCount float64
    Number of consecutive checks must fail before marking it down.
    Interval float64
    The frequency at which the system issues the monitor check (in seconds).
    LbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RiseCount float64
    Number of consecutive checks must pass before marking it up.
    Tags []LbIcmpMonitorTagArgs
    A list of scope + tag pairs to associate with this lb icmp monitor.
    Timeout float64
    Number of seconds the target has in which to respond to the monitor request.
    dataLength Double
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    fallCount Double
    Number of consecutive checks must fail before marking it down.
    interval Double
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId String
    ID of the lb_icmp_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount Double
    Number of consecutive checks must pass before marking it up.
    tags List<LbIcmpMonitorTag>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout Double
    Number of seconds the target has in which to respond to the monitor request.
    dataLength number
    The data size (in bytes) of the ICMP healthcheck packet.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    fallCount number
    Number of consecutive checks must fail before marking it down.
    interval number
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId string
    ID of the lb_icmp_monitor.
    monitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount number
    Number of consecutive checks must pass before marking it up.
    tags LbIcmpMonitorTag[]
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout number
    Number of seconds the target has in which to respond to the monitor request.
    data_length float
    The data size (in bytes) of the ICMP healthcheck packet.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    fall_count float
    Number of consecutive checks must fail before marking it down.
    interval float
    The frequency at which the system issues the monitor check (in seconds).
    lb_icmp_monitor_id str
    ID of the lb_icmp_monitor.
    monitor_port str
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    rise_count float
    Number of consecutive checks must pass before marking it up.
    tags Sequence[LbIcmpMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout float
    Number of seconds the target has in which to respond to the monitor request.
    dataLength Number
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    fallCount Number
    Number of consecutive checks must fail before marking it down.
    interval Number
    The frequency at which the system issues the monitor check (in seconds).
    lbIcmpMonitorId String
    ID of the lb_icmp_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. Port range is not supported.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    riseCount Number
    Number of consecutive checks must pass before marking it up.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb icmp monitor.
    timeout Number
    Number of seconds the target has in which to respond to the monitor request.

    Supporting Types

    LbIcmpMonitorTag, LbIcmpMonitorTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb icmp monitor.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb icmp monitor.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb icmp monitor.
    scope string
    tag string
    A list of scope + tag pairs to associate with this lb icmp monitor.
    scope str
    tag str
    A list of scope + tag pairs to associate with this lb icmp monitor.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb icmp 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
    vmware/terraform-provider-nsxt