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

nsxt.LbHttpsMonitor

Explore with Pulumi AI

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

    Create LbHttpsMonitor Resource

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

    Constructor syntax

    new LbHttpsMonitor(name: string, args?: LbHttpsMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def LbHttpsMonitor(resource_name: str,
                       args: Optional[LbHttpsMonitorArgs] = None,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def LbHttpsMonitor(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       certificate_chain_depth: Optional[float] = None,
                       ciphers: Optional[Sequence[str]] = None,
                       client_certificate_id: Optional[str] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       fall_count: Optional[float] = None,
                       interval: Optional[float] = None,
                       lb_https_monitor_id: Optional[str] = None,
                       monitor_port: Optional[str] = None,
                       protocols: Optional[Sequence[str]] = None,
                       request_body: Optional[str] = None,
                       request_headers: Optional[Sequence[LbHttpsMonitorRequestHeaderArgs]] = None,
                       request_method: Optional[str] = None,
                       request_url: Optional[str] = None,
                       request_version: Optional[str] = None,
                       response_body: Optional[str] = None,
                       response_status_codes: Optional[Sequence[float]] = None,
                       rise_count: Optional[float] = None,
                       server_auth: Optional[str] = None,
                       server_auth_ca_ids: Optional[Sequence[str]] = None,
                       server_auth_crl_ids: Optional[Sequence[str]] = None,
                       tags: Optional[Sequence[LbHttpsMonitorTagArgs]] = None,
                       timeout: Optional[float] = None)
    func NewLbHttpsMonitor(ctx *Context, name string, args *LbHttpsMonitorArgs, opts ...ResourceOption) (*LbHttpsMonitor, error)
    public LbHttpsMonitor(string name, LbHttpsMonitorArgs? args = null, CustomResourceOptions? opts = null)
    public LbHttpsMonitor(String name, LbHttpsMonitorArgs args)
    public LbHttpsMonitor(String name, LbHttpsMonitorArgs args, CustomResourceOptions options)
    
    type: nsxt:LbHttpsMonitor
    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 LbHttpsMonitorArgs
    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 LbHttpsMonitorArgs
    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 LbHttpsMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LbHttpsMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LbHttpsMonitorArgs
    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 lbHttpsMonitorResource = new Nsxt.LbHttpsMonitor("lbHttpsMonitorResource", new()
    {
        CertificateChainDepth = 0,
        Ciphers = new[]
        {
            "string",
        },
        ClientCertificateId = "string",
        Description = "string",
        DisplayName = "string",
        FallCount = 0,
        Interval = 0,
        LbHttpsMonitorId = "string",
        MonitorPort = "string",
        Protocols = new[]
        {
            "string",
        },
        RequestBody = "string",
        RequestHeaders = new[]
        {
            new Nsxt.Inputs.LbHttpsMonitorRequestHeaderArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        RequestMethod = "string",
        RequestUrl = "string",
        RequestVersion = "string",
        ResponseBody = "string",
        ResponseStatusCodes = new[]
        {
            0,
        },
        RiseCount = 0,
        ServerAuth = "string",
        ServerAuthCaIds = new[]
        {
            "string",
        },
        ServerAuthCrlIds = new[]
        {
            "string",
        },
        Tags = new[]
        {
            new Nsxt.Inputs.LbHttpsMonitorTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        Timeout = 0,
    });
    
    example, err := nsxt.NewLbHttpsMonitor(ctx, "lbHttpsMonitorResource", &nsxt.LbHttpsMonitorArgs{
    	CertificateChainDepth: pulumi.Float64(0),
    	Ciphers: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ClientCertificateId: pulumi.String("string"),
    	Description:         pulumi.String("string"),
    	DisplayName:         pulumi.String("string"),
    	FallCount:           pulumi.Float64(0),
    	Interval:            pulumi.Float64(0),
    	LbHttpsMonitorId:    pulumi.String("string"),
    	MonitorPort:         pulumi.String("string"),
    	Protocols: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RequestBody: pulumi.String("string"),
    	RequestHeaders: nsxt.LbHttpsMonitorRequestHeaderArray{
    		&nsxt.LbHttpsMonitorRequestHeaderArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	RequestMethod:  pulumi.String("string"),
    	RequestUrl:     pulumi.String("string"),
    	RequestVersion: pulumi.String("string"),
    	ResponseBody:   pulumi.String("string"),
    	ResponseStatusCodes: pulumi.Float64Array{
    		pulumi.Float64(0),
    	},
    	RiseCount:  pulumi.Float64(0),
    	ServerAuth: pulumi.String("string"),
    	ServerAuthCaIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ServerAuthCrlIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: nsxt.LbHttpsMonitorTagArray{
    		&nsxt.LbHttpsMonitorTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	Timeout: pulumi.Float64(0),
    })
    
    var lbHttpsMonitorResource = new LbHttpsMonitor("lbHttpsMonitorResource", LbHttpsMonitorArgs.builder()
        .certificateChainDepth(0)
        .ciphers("string")
        .clientCertificateId("string")
        .description("string")
        .displayName("string")
        .fallCount(0)
        .interval(0)
        .lbHttpsMonitorId("string")
        .monitorPort("string")
        .protocols("string")
        .requestBody("string")
        .requestHeaders(LbHttpsMonitorRequestHeaderArgs.builder()
            .name("string")
            .value("string")
            .build())
        .requestMethod("string")
        .requestUrl("string")
        .requestVersion("string")
        .responseBody("string")
        .responseStatusCodes(0)
        .riseCount(0)
        .serverAuth("string")
        .serverAuthCaIds("string")
        .serverAuthCrlIds("string")
        .tags(LbHttpsMonitorTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .timeout(0)
        .build());
    
    lb_https_monitor_resource = nsxt.LbHttpsMonitor("lbHttpsMonitorResource",
        certificate_chain_depth=0,
        ciphers=["string"],
        client_certificate_id="string",
        description="string",
        display_name="string",
        fall_count=0,
        interval=0,
        lb_https_monitor_id="string",
        monitor_port="string",
        protocols=["string"],
        request_body="string",
        request_headers=[{
            "name": "string",
            "value": "string",
        }],
        request_method="string",
        request_url="string",
        request_version="string",
        response_body="string",
        response_status_codes=[0],
        rise_count=0,
        server_auth="string",
        server_auth_ca_ids=["string"],
        server_auth_crl_ids=["string"],
        tags=[{
            "scope": "string",
            "tag": "string",
        }],
        timeout=0)
    
    const lbHttpsMonitorResource = new nsxt.LbHttpsMonitor("lbHttpsMonitorResource", {
        certificateChainDepth: 0,
        ciphers: ["string"],
        clientCertificateId: "string",
        description: "string",
        displayName: "string",
        fallCount: 0,
        interval: 0,
        lbHttpsMonitorId: "string",
        monitorPort: "string",
        protocols: ["string"],
        requestBody: "string",
        requestHeaders: [{
            name: "string",
            value: "string",
        }],
        requestMethod: "string",
        requestUrl: "string",
        requestVersion: "string",
        responseBody: "string",
        responseStatusCodes: [0],
        riseCount: 0,
        serverAuth: "string",
        serverAuthCaIds: ["string"],
        serverAuthCrlIds: ["string"],
        tags: [{
            scope: "string",
            tag: "string",
        }],
        timeout: 0,
    });
    
    type: nsxt:LbHttpsMonitor
    properties:
        certificateChainDepth: 0
        ciphers:
            - string
        clientCertificateId: string
        description: string
        displayName: string
        fallCount: 0
        interval: 0
        lbHttpsMonitorId: string
        monitorPort: string
        protocols:
            - string
        requestBody: string
        requestHeaders:
            - name: string
              value: string
        requestMethod: string
        requestUrl: string
        requestVersion: string
        responseBody: string
        responseStatusCodes:
            - 0
        riseCount: 0
        serverAuth: string
        serverAuthCaIds:
            - string
        serverAuthCrlIds:
            - string
        tags:
            - scope: string
              tag: string
        timeout: 0
    

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

    CertificateChainDepth double
    Authentication depth is used to set the verification depth in the server certificates chain.
    Ciphers List<string>
    List of supported SSL ciphers.
    ClientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    Interval double
    The frequency at which the system issues the monitor check (in seconds).
    LbHttpsMonitorId string
    ID of the lb_https_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    Protocols List<string>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    RequestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders List<LbHttpsMonitorRequestHeader>
    HTTP request headers.
    RequestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    RequestUrl string
    URL used for HTTP monitor.
    RequestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    ResponseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    ResponseStatusCodes List<double>
    HTTP response status code should be a valid HTTP status code.
    RiseCount double
    Number of consecutive checks that must pass before marking it up.
    ServerAuth string
    Server authentication mode - REQUIRED or IGNORE.
    ServerAuthCaIds List<string>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlIds List<string>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    Tags List<LbHttpsMonitorTag>
    A list of scope + tag pairs to associate with this lb https monitor.
    Timeout double
    Number of seconds the target has to respond to the monitor request.
    CertificateChainDepth float64
    Authentication depth is used to set the verification depth in the server certificates chain.
    Ciphers []string
    List of supported SSL ciphers.
    ClientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    Interval float64
    The frequency at which the system issues the monitor check (in seconds).
    LbHttpsMonitorId string
    ID of the lb_https_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    Protocols []string
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    RequestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders []LbHttpsMonitorRequestHeaderArgs
    HTTP request headers.
    RequestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    RequestUrl string
    URL used for HTTP monitor.
    RequestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    ResponseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    ResponseStatusCodes []float64
    HTTP response status code should be a valid HTTP status code.
    RiseCount float64
    Number of consecutive checks that must pass before marking it up.
    ServerAuth string
    Server authentication mode - REQUIRED or IGNORE.
    ServerAuthCaIds []string
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlIds []string
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    Tags []LbHttpsMonitorTagArgs
    A list of scope + tag pairs to associate with this lb https monitor.
    Timeout float64
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth Double
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers List<String>
    List of supported SSL ciphers.
    clientCertificateId String
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval Double
    The frequency at which the system issues the monitor check (in seconds).
    lbHttpsMonitorId String
    ID of the lb_https_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols List<String>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody String
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<LbHttpsMonitorRequestHeader>
    HTTP request headers.
    requestMethod String
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl String
    URL used for HTTP monitor.
    requestVersion String
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody String
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes List<Double>
    HTTP response status code should be a valid HTTP status code.
    riseCount Double
    Number of consecutive checks that must pass before marking it up.
    serverAuth String
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags List<LbHttpsMonitorTag>
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout Double
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth number
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers string[]
    List of supported SSL ciphers.
    clientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval number
    The frequency at which the system issues the monitor check (in seconds).
    lbHttpsMonitorId string
    ID of the lb_https_monitor.
    monitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols string[]
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders LbHttpsMonitorRequestHeader[]
    HTTP request headers.
    requestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl string
    URL used for HTTP monitor.
    requestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes number[]
    HTTP response status code should be a valid HTTP status code.
    riseCount number
    Number of consecutive checks that must pass before marking it up.
    serverAuth string
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds string[]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds string[]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags LbHttpsMonitorTag[]
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout number
    Number of seconds the target has to respond to the monitor request.
    certificate_chain_depth float
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers Sequence[str]
    List of supported SSL ciphers.
    client_certificate_id str
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval float
    The frequency at which the system issues the monitor check (in seconds).
    lb_https_monitor_id str
    ID of the lb_https_monitor.
    monitor_port str
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols Sequence[str]
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    request_body str
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    request_headers Sequence[LbHttpsMonitorRequestHeaderArgs]
    HTTP request headers.
    request_method str
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    request_url str
    URL used for HTTP monitor.
    request_version str
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    response_body str
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    response_status_codes Sequence[float]
    HTTP response status code should be a valid HTTP status code.
    rise_count float
    Number of consecutive checks that must pass before marking it up.
    server_auth str
    Server authentication mode - REQUIRED or IGNORE.
    server_auth_ca_ids Sequence[str]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    server_auth_crl_ids Sequence[str]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags Sequence[LbHttpsMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout float
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth Number
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers List<String>
    List of supported SSL ciphers.
    clientCertificateId String
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval Number
    The frequency at which the system issues the monitor check (in seconds).
    lbHttpsMonitorId String
    ID of the lb_https_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols List<String>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody String
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<Property Map>
    HTTP request headers.
    requestMethod String
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl String
    URL used for HTTP monitor.
    requestVersion String
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody String
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes List<Number>
    HTTP response status code should be a valid HTTP status code.
    riseCount Number
    Number of consecutive checks that must pass before marking it up.
    serverAuth String
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout Number
    Number of seconds the target has to respond to the monitor request.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LbHttpsMonitor resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IsSecure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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.
    IsSecure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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.
    isSecure Boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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.
    isSecure boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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.
    is_secure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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.
    isSecure Boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    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 LbHttpsMonitor Resource

    Get an existing LbHttpsMonitor 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?: LbHttpsMonitorState, opts?: CustomResourceOptions): LbHttpsMonitor
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_chain_depth: Optional[float] = None,
            ciphers: Optional[Sequence[str]] = None,
            client_certificate_id: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            fall_count: Optional[float] = None,
            interval: Optional[float] = None,
            is_secure: Optional[bool] = None,
            lb_https_monitor_id: Optional[str] = None,
            monitor_port: Optional[str] = None,
            protocols: Optional[Sequence[str]] = None,
            request_body: Optional[str] = None,
            request_headers: Optional[Sequence[LbHttpsMonitorRequestHeaderArgs]] = None,
            request_method: Optional[str] = None,
            request_url: Optional[str] = None,
            request_version: Optional[str] = None,
            response_body: Optional[str] = None,
            response_status_codes: Optional[Sequence[float]] = None,
            revision: Optional[float] = None,
            rise_count: Optional[float] = None,
            server_auth: Optional[str] = None,
            server_auth_ca_ids: Optional[Sequence[str]] = None,
            server_auth_crl_ids: Optional[Sequence[str]] = None,
            tags: Optional[Sequence[LbHttpsMonitorTagArgs]] = None,
            timeout: Optional[float] = None) -> LbHttpsMonitor
    func GetLbHttpsMonitor(ctx *Context, name string, id IDInput, state *LbHttpsMonitorState, opts ...ResourceOption) (*LbHttpsMonitor, error)
    public static LbHttpsMonitor Get(string name, Input<string> id, LbHttpsMonitorState? state, CustomResourceOptions? opts = null)
    public static LbHttpsMonitor get(String name, Output<String> id, LbHttpsMonitorState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LbHttpsMonitor    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:
    CertificateChainDepth double
    Authentication depth is used to set the verification depth in the server certificates chain.
    Ciphers List<string>
    List of supported SSL ciphers.
    ClientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    Interval double
    The frequency at which the system issues the monitor check (in seconds).
    IsSecure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    LbHttpsMonitorId string
    ID of the lb_https_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    Protocols List<string>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    RequestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders List<LbHttpsMonitorRequestHeader>
    HTTP request headers.
    RequestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    RequestUrl string
    URL used for HTTP monitor.
    RequestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    ResponseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    ResponseStatusCodes List<double>
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    ServerAuth string
    Server authentication mode - REQUIRED or IGNORE.
    ServerAuthCaIds List<string>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlIds List<string>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    Tags List<LbHttpsMonitorTag>
    A list of scope + tag pairs to associate with this lb https monitor.
    Timeout double
    Number of seconds the target has to respond to the monitor request.
    CertificateChainDepth float64
    Authentication depth is used to set the verification depth in the server certificates chain.
    Ciphers []string
    List of supported SSL ciphers.
    ClientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    Interval float64
    The frequency at which the system issues the monitor check (in seconds).
    IsSecure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    LbHttpsMonitorId string
    ID of the lb_https_monitor.
    MonitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    Protocols []string
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    RequestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    RequestHeaders []LbHttpsMonitorRequestHeaderArgs
    HTTP request headers.
    RequestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    RequestUrl string
    URL used for HTTP monitor.
    RequestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    ResponseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    ResponseStatusCodes []float64
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    ServerAuth string
    Server authentication mode - REQUIRED or IGNORE.
    ServerAuthCaIds []string
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    ServerAuthCrlIds []string
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    Tags []LbHttpsMonitorTagArgs
    A list of scope + tag pairs to associate with this lb https monitor.
    Timeout float64
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth Double
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers List<String>
    List of supported SSL ciphers.
    clientCertificateId String
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval Double
    The frequency at which the system issues the monitor check (in seconds).
    isSecure Boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    lbHttpsMonitorId String
    ID of the lb_https_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols List<String>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody String
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<LbHttpsMonitorRequestHeader>
    HTTP request headers.
    requestMethod String
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl String
    URL used for HTTP monitor.
    requestVersion String
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody String
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes List<Double>
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    serverAuth String
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags List<LbHttpsMonitorTag>
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout Double
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth number
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers string[]
    List of supported SSL ciphers.
    clientCertificateId string
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval number
    The frequency at which the system issues the monitor check (in seconds).
    isSecure boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    lbHttpsMonitorId string
    ID of the lb_https_monitor.
    monitorPort string
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols string[]
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody string
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders LbHttpsMonitorRequestHeader[]
    HTTP request headers.
    requestMethod string
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl string
    URL used for HTTP monitor.
    requestVersion string
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody string
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes number[]
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    serverAuth string
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds string[]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds string[]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags LbHttpsMonitorTag[]
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout number
    Number of seconds the target has to respond to the monitor request.
    certificate_chain_depth float
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers Sequence[str]
    List of supported SSL ciphers.
    client_certificate_id str
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval float
    The frequency at which the system issues the monitor check (in seconds).
    is_secure bool
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    lb_https_monitor_id str
    ID of the lb_https_monitor.
    monitor_port str
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols Sequence[str]
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    request_body str
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    request_headers Sequence[LbHttpsMonitorRequestHeaderArgs]
    HTTP request headers.
    request_method str
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    request_url str
    URL used for HTTP monitor.
    request_version str
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    response_body str
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    response_status_codes Sequence[float]
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    server_auth str
    Server authentication mode - REQUIRED or IGNORE.
    server_auth_ca_ids Sequence[str]
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    server_auth_crl_ids Sequence[str]
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags Sequence[LbHttpsMonitorTagArgs]
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout float
    Number of seconds the target has to respond to the monitor request.
    certificateChainDepth Number
    Authentication depth is used to set the verification depth in the server certificates chain.
    ciphers List<String>
    List of supported SSL ciphers.
    clientCertificateId String
    Client certificate can be specified to support client authentication.
    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 that must fail before marking it down.
    interval Number
    The frequency at which the system issues the monitor check (in seconds).
    isSecure Boolean
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.
    lbHttpsMonitorId String
    ID of the lb_https_monitor.
    monitorPort String
    If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported.
    protocols List<String>
    SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.
    requestBody String
    String to send as HTTP health check request body. Valid only for certain HTTP methods like POST.
    requestHeaders List<Property Map>
    HTTP request headers.
    requestMethod String
    Health check method for HTTP monitor type. Valid values are GET, HEAD, PUT, POST and OPTIONS.
    requestUrl String
    URL used for HTTP monitor.
    requestVersion String
    HTTP request version. Valid values are HTTP_VERSION_1_0 and HTTP_VERSION_1_1.
    responseBody String
    If response body is specified, healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match (regular expressions not supported). If response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is among configured values.
    responseStatusCodes List<Number>
    HTTP response status code should be a valid HTTP status code.
    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 that must pass before marking it up.
    serverAuth String
    Server authentication mode - REQUIRED or IGNORE.
    serverAuthCaIds List<String>
    If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.
    serverAuthCrlIds List<String>
    A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this lb https monitor.
    timeout Number
    Number of seconds the target has to respond to the monitor request.

    Supporting Types

    LbHttpsMonitorRequestHeader, LbHttpsMonitorRequestHeaderArgs

    Name string
    Header name
    Value string
    Header value
    Name string
    Header name
    Value string
    Header value
    name String
    Header name
    value String
    Header value
    name string
    Header name
    value string
    Header value
    name str
    Header name
    value str
    Header value
    name String
    Header name
    value String
    Header value

    LbHttpsMonitorTag, LbHttpsMonitorTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb https monitor.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this lb https monitor.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb https monitor.
    scope string
    tag string
    A list of scope + tag pairs to associate with this lb https monitor.
    scope str
    tag str
    A list of scope + tag pairs to associate with this lb https monitor.
    scope String
    tag String
    A list of scope + tag pairs to associate with this lb https 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