# openstack.network.v2.health_monitor

## The HealthMonitor Class

The `HealthMonitor` class inherits from `Resource`.

class openstack.network.v2.health_monitor.HealthMonitor(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'healthmonitor'

    Singular form of key for resource.

  resources_key = 'healthmonitors'

    Plural form of key for resource.

  base_path = '/lbaas/healthmonitors'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  delay

    The time, in seconds, between sending probes to members.

  expected_codes

    Expected HTTP codes for a passing HTTP(S) monitor.

  http_method

    The HTTP method that the monitor uses for requests.

  is_admin_state_up

    The administrative state of the health monitor, which is up `True` or down `False`. Type: bool

  max_retries

    Maximum consecutive health probe tries.

  name

    Name of the health monitor.

  pool_ids

    List of pools associated with this health monitor Type: list of dicts which contain the pool IDs

  pool_id

    The ID of the pool associated with this health monitor

  project_id

    The ID of the project this health monitor is associated with.

  tenant_id

    Tenant_id (deprecated attribute).

  timeout

    The maximum number of seconds for a monitor to wait for a connection to be established before it times out. This value must be less than the delay value.

  type

    The type of probe sent by the load balancer to verify the member state, which is PING, TCP, HTTP, or HTTPS.

  url_path

    Path portion of URI that will be probed if type is HTTP(S).

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.