Monitor

Manages a V2 monitor resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var monitor1 = new OpenStack.LoadBalancer.Monitor("monitor1", new OpenStack.LoadBalancer.MonitorArgs
        {
            Delay = 20,
            MaxRetries = 5,
            PoolId = openstack_lb_pool_v2.Pool_1.Id,
            Timeout = 10,
            Type = "PING",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

monitor1 = openstack.loadbalancer.Monitor("monitor1",
    delay=20,
    max_retries=5,
    pool_id=openstack_lb_pool_v2["pool_1"]["id"],
    timeout=10,
    type="PING")

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const monitor1 = new openstack.loadbalancer.Monitor("monitor_1", {
    delay: 20,
    maxRetries: 5,
    poolId: openstack_lb_pool_v2_pool_1.id,
    timeout: 10,
    type: "PING",
});

Create a Monitor Resource

new Monitor(name: string, args: MonitorArgs, opts?: CustomResourceOptions);

def Monitor(resource_name, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, max_retries_down=None, name=None, pool_id=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None);

func NewMonitor(ctx *Context, name string, args MonitorArgs, opts ...ResourceOption) (*Monitor, error)

public Monitor(string name, MonitorArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Monitor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Monitor resource accepts the following input properties:

Delay int: The time, in seconds, between sending probes to members.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
PoolId string: The id of the pool that this monitor will be assigned to.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
Type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
AdminStateUp bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
MaxRetriesDown int: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
Name string: The Name of the Monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
TenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

Delay int: The time, in seconds, between sending probes to members.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
PoolId string: The id of the pool that this monitor will be assigned to.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
Type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
AdminStateUp bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
MaxRetriesDown int: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
Name string: The Name of the Monitor.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
TenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

delay number: The time, in seconds, between sending probes to members.
maxRetries number: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
poolId string: The id of the pool that this monitor will be assigned to.
timeout number: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
adminStateUp boolean: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
expectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
httpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
maxRetriesDown number: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
name string: The Name of the Monitor.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
tenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
urlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

delay float: The time, in seconds, between sending probes to members.
max_retries float: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
pool_id str: The id of the pool that this monitor will be assigned to.
timeout float: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
type str: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
admin_state_up bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
expected_codes str: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
http_method str: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
max_retries_down float: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
name str: The Name of the Monitor.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
tenant_id str: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
url_path str: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Monitor Resource

Get an existing Monitor 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?: MonitorState, opts?: CustomResourceOptions): Monitor

static get(resource_name, id, opts=None, admin_state_up=None, delay=None, expected_codes=None, http_method=None, max_retries=None, max_retries_down=None, name=None, pool_id=None, region=None, tenant_id=None, timeout=None, type=None, url_path=None, __props__=None);

func GetMonitor(ctx *Context, name string, id IDInput, state *MonitorState, opts ...ResourceOption) (*Monitor, error)

public static Monitor Get(string name, Input<string> id, MonitorState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AdminStateUp bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
Delay int: The time, in seconds, between sending probes to members.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
MaxRetriesDown int: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
Name string: The Name of the Monitor.
PoolId string: The id of the pool that this monitor will be assigned to.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
TenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
Type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

AdminStateUp bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
Delay int: The time, in seconds, between sending probes to members.
ExpectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
HttpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
MaxRetries int: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
MaxRetriesDown int: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
Name string: The Name of the Monitor.
PoolId string: The id of the pool that this monitor will be assigned to.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
TenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
Timeout int: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
Type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
UrlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

adminStateUp boolean: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
delay number: The time, in seconds, between sending probes to members.
expectedCodes string: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
httpMethod string: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
maxRetries number: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
maxRetriesDown number: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
name string: The Name of the Monitor.
poolId string: The id of the pool that this monitor will be assigned to.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
tenantId string: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
timeout number: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
type string: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
urlPath string: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

admin_state_up bool: The administrative state of the monitor. A valid value is true (UP) or false (DOWN).
delay float: The time, in seconds, between sending probes to members.
expected_codes str: Required for HTTP(S) types. Expected HTTP codes for a passing HTTP(S) monitor. You can either specify a single status like “200”, or a range like “200-202”.
http_method str: Required for HTTP(S) types. The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to “GET”.
max_retries float: Number of permissible ping failures before changing the member’s status to INACTIVE. Must be a number between 1 and 10.
max_retries_down float: Number of permissible ping failures befor changing the member’s status to ERROR. Must be a number between 1 and 10 (supported only in Octavia). Changing this updates the max_retries_down of the existing monitor.
name str: The Name of the Monitor.
pool_id str: The id of the pool that this monitor will be assigned to.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create an . If omitted, the region argument of the provider is used. Changing this creates a new monitor.
tenant_id str: Required for admins. The UUID of the tenant who owns the monitor. Only administrative users can specify a tenant UUID other than their own. Changing this creates a new monitor.
timeout float: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
type str: The type of probe, which is PING, TCP, HTTP, HTTPS, TLS-HELLO or UDP-CONNECT (supported only in Octavia), that is sent by the load balancer to verify the member state. Changing this creates a new monitor.
url_path str: Required for HTTP(S) types. URI path that will be accessed if monitor type is HTTP or HTTPS.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud