# openstack.network.v2.agent

## The Agent Class

The `Agent` class inherits from `Resource`.

class openstack.network.v2.agent.Agent(_synchronized=False, connection=None, **attrs)

  Neutron agent extension.

  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 = 'agent'

    Singular form of key for resource.

  resources_key = 'agents'

    Plural form of key for resource.

  base_path = '/agents'

    The base part of the URI for this resource.

  allow_create = False

    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.

  agent_type

    The type of network agent.

  availability_zone

    Availability zone for the network agent.

  binary

    The name of the network agent’s application binary.

  configuration

    Network agent configuration data specific to the agent_type.

  created_at

    Timestamp when the network agent was created.

  description

    The network agent description.

  last_heartbeat_at

    Timestamp when the network agent’s heartbeat was last seen.

  host

    The host the agent is running on.

  is_admin_state_up

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

  is_alive

    Whether or not the network agent is alive. Type: bool

  resources_synced

    Whether or not the agent is succesffully synced towards placement. Agents supporting the guaranteed minimum bandwidth feature share their resource view with neutron-server and neutron-server share this view with placement, resources_synced represents the success of the latter. The value None means no resource view synchronization to Placement was attempted. true / false values signify the success of the last synchronization attempt. Type: bool

  started_at

    Timestamp when the network agent was last started.

  topic

    The messaging queue topic the network agent subscribes to.

  ha_state

    The HA state of the L3 agent. This is one of ‘active’, ‘standby’ or ‘fault’ for HA routers, or None for other types of routers.

  get_bgp_speakers_hosted_by_dragent(session)

    List BGP speakers hosted by a Dynamic Routing Agent

    Parameters:

      session (`Adapter`) – The session to communicate through.

    Returns:

      A list of BgpSpeakers

    Return type:

      `BgpSpeaker`

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.