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

nsxt.PolicyLbIcmpMonitorProfile

Explore with Pulumi AI

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

    Create PolicyLbIcmpMonitorProfile Resource

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

    Constructor syntax

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

@overload
def PolicyLbIcmpMonitorProfile(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               display_name: Optional[str] = None,
                               data_length: Optional[float] = None,
                               description: Optional[str] = None,
                               fall_count: Optional[float] = None,
                               interval: Optional[float] = None,
                               nsx_id: Optional[str] = None,
                               policy_lb_icmp_monitor_profile_id: Optional[str] = None,
                               rise_count: Optional[float] = None,
                               tags: Optional[Sequence[PolicyLbIcmpMonitorProfileTagArgs]] = None,
                               timeout: Optional[float] = None)
    func NewPolicyLbIcmpMonitorProfile(ctx *Context, name string, args PolicyLbIcmpMonitorProfileArgs, opts ...ResourceOption) (*PolicyLbIcmpMonitorProfile, error)
    public PolicyLbIcmpMonitorProfile(string name, PolicyLbIcmpMonitorProfileArgs args, CustomResourceOptions? opts = null)
    public PolicyLbIcmpMonitorProfile(String name, PolicyLbIcmpMonitorProfileArgs args)
public PolicyLbIcmpMonitorProfile(String name, PolicyLbIcmpMonitorProfileArgs args, CustomResourceOptions options)

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

    example, err := nsxt.NewPolicyLbIcmpMonitorProfile(ctx, "policyLbIcmpMonitorProfileResource", &nsxt.PolicyLbIcmpMonitorProfileArgs{
	DisplayName:                  pulumi.String("string"),
	DataLength:                   pulumi.Float64(0),
	Description:                  pulumi.String("string"),
	FallCount:                    pulumi.Float64(0),
	Interval:                     pulumi.Float64(0),
	NsxId:                        pulumi.String("string"),
	PolicyLbIcmpMonitorProfileId: pulumi.String("string"),
	RiseCount:                    pulumi.Float64(0),
	Tags: nsxt.PolicyLbIcmpMonitorProfileTagArray{
		&nsxt.PolicyLbIcmpMonitorProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Timeout: pulumi.Float64(0),
})

    var policyLbIcmpMonitorProfileResource = new PolicyLbIcmpMonitorProfile("policyLbIcmpMonitorProfileResource", PolicyLbIcmpMonitorProfileArgs.builder()
    .displayName("string")
    .dataLength(0)
    .description("string")
    .fallCount(0)
    .interval(0)
    .nsxId("string")
    .policyLbIcmpMonitorProfileId("string")
    .riseCount(0)
    .tags(PolicyLbIcmpMonitorProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .timeout(0)
    .build());

    policy_lb_icmp_monitor_profile_resource = nsxt.PolicyLbIcmpMonitorProfile("policyLbIcmpMonitorProfileResource",
    display_name="string",
    data_length=0,
    description="string",
    fall_count=0,
    interval=0,
    nsx_id="string",
    policy_lb_icmp_monitor_profile_id="string",
    rise_count=0,
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    timeout=0)

    const policyLbIcmpMonitorProfileResource = new nsxt.PolicyLbIcmpMonitorProfile("policyLbIcmpMonitorProfileResource", {
    displayName: "string",
    dataLength: 0,
    description: "string",
    fallCount: 0,
    interval: 0,
    nsxId: "string",
    policyLbIcmpMonitorProfileId: "string",
    riseCount: 0,
    tags: [{
        scope: "string",
        tag: "string",
    }],
    timeout: 0,
});

    type: nsxt:PolicyLbIcmpMonitorProfile
properties:
    dataLength: 0
    description: string
    displayName: string
    fallCount: 0
    interval: 0
    nsxId: string
    policyLbIcmpMonitorProfileId: string
    riseCount: 0
    tags:
        - scope: string
          tag: string
    timeout: 0

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

    DisplayName string
    Display name of the resource.
    DataLength double
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of the resource.
    FallCount double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbIcmpMonitorProfileId string
    ID of the resource.
    RiseCount double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags List<PolicyLbIcmpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    DisplayName string
    Display name of the resource.
    DataLength float64
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of the resource.
    FallCount float64
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval float64
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyLbIcmpMonitorProfileId string
    ID of the resource.
    RiseCount float64
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags []PolicyLbIcmpMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName String
    Display name of the resource.
    dataLength Double
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of the resource.
    fallCount Double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbIcmpMonitorProfileId String
    ID of the resource.
    riseCount Double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<PolicyLbIcmpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName string
    Display name of the resource.
    dataLength number
    The data size (in bytes) of the ICMP healthcheck packet.
    description string
    Description of the resource.
    fallCount number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbIcmpMonitorProfileId string
    ID of the resource.
    riseCount number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags PolicyLbIcmpMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    display_name str
    Display name of the resource.
    data_length float
    The data size (in bytes) of the ICMP healthcheck packet.
    description str
    Description of the resource.
    fall_count float
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval float
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_lb_icmp_monitor_profile_id str
    ID of the resource.
    rise_count float
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags Sequence[PolicyLbIcmpMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    displayName String
    Display name of the resource.
    dataLength Number
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of the resource.
    fallCount Number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyLbIcmpMonitorProfileId String
    ID of the resource.
    riseCount Number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

    Outputs

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

    Get an existing PolicyLbIcmpMonitorProfile 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?: PolicyLbIcmpMonitorProfileState, opts?: CustomResourceOptions): PolicyLbIcmpMonitorProfile
    @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,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_lb_icmp_monitor_profile_id: Optional[str] = None,
        revision: Optional[float] = None,
        rise_count: Optional[float] = None,
        tags: Optional[Sequence[PolicyLbIcmpMonitorProfileTagArgs]] = None,
        timeout: Optional[float] = None) -> PolicyLbIcmpMonitorProfile
    func GetPolicyLbIcmpMonitorProfile(ctx *Context, name string, id IDInput, state *PolicyLbIcmpMonitorProfileState, opts ...ResourceOption) (*PolicyLbIcmpMonitorProfile, error)
    public static PolicyLbIcmpMonitorProfile Get(string name, Input<string> id, PolicyLbIcmpMonitorProfileState? state, CustomResourceOptions? opts = null)
    public static PolicyLbIcmpMonitorProfile get(String name, Output<String> id, PolicyLbIcmpMonitorProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyLbIcmpMonitorProfile    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 the resource.
    DisplayName string
    Display name of the resource.
    FallCount double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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.
    PolicyLbIcmpMonitorProfileId 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.
    RiseCount double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags List<PolicyLbIcmpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    Timeout double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    DataLength float64
    The data size (in bytes) of the ICMP healthcheck packet.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    FallCount float64
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    Interval float64
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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.
    PolicyLbIcmpMonitorProfileId 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.
    RiseCount float64
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    Tags []PolicyLbIcmpMonitorProfileTagArgs
    A list of scope + tag pairs to associate with this resource.
    Timeout float64
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    dataLength Double
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    fallCount Double
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Double
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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.
    policyLbIcmpMonitorProfileId 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.
    riseCount Double
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<PolicyLbIcmpMonitorProfileTag>
    A list of scope + tag pairs to associate with this resource.
    timeout Double
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    dataLength number
    The data size (in bytes) of the ICMP healthcheck packet.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    fallCount number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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.
    policyLbIcmpMonitorProfileId 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.
    riseCount number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags PolicyLbIcmpMonitorProfileTag[]
    A list of scope + tag pairs to associate with this resource.
    timeout number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    data_length float
    The data size (in bytes) of the ICMP healthcheck packet.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    fall_count float
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval float
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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_icmp_monitor_profile_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.
    rise_count float
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags Sequence[PolicyLbIcmpMonitorProfileTagArgs]
    A list of scope + tag pairs to associate with this resource.
    timeout float
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.
    dataLength Number
    The data size (in bytes) of the ICMP healthcheck packet.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    fallCount Number
    Mark member status DOWN if the healtcheck fails consecutively for fall_count times.
    interval Number
    Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
    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.
    policyLbIcmpMonitorProfileId 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.
    riseCount Number
    Bring a DOWN member UP if rise_count successive healthchecks succeed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    timeout Number
    Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout.

    Supporting Types

    PolicyLbIcmpMonitorProfileTag, PolicyLbIcmpMonitorProfileTagArgs

    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