# openstack.network.v2.vpn_service

## The VpnService Class

The `VpnService` class inherits from `Resource`.

class openstack.network.v2.vpn_service.VpnService(_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 = 'vpnservice'

    Singular form of key for resource.

  resources_key = 'vpnservices'

    Plural form of key for resource.

  base_path = '/vpn/vpnservices'

    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.

  description

    Human-readable description for the vpnservice.

  external_v4_ip

    The external IPv4 address that is used for the VPN service.

  external_v6_ip

    The external IPv6 address that is used for the VPN service.

  is_admin_state_up

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

  name

    The vpnservice name.

  router_id

    ID of the router into which the VPN service is inserted.

  project_id

    The ID of the project this vpnservice is associated with.

  tenant_id

    Tenant_id (deprecated attribute).

  status

    The vpnservice status.

  subnet_id

    The ID of the subnet on which the tenant wants the vpnservice.

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.