openstack.network.v2.router

The Router Class

The Router class inherits from Resource.

class openstack.network.v2.router.Router(_synchronized=False, **attrs)

The base resource

Parameters:_synchronized (bool) – This is not intended to be used directly. See new() and existing().
availability_zone_hints = None

Availability zone hints to use when scheduling the router. Type: list of availability zone names

availability_zones = None

Availability zones for the router. Type: list of availability zone names

created_at = None

Timestamp when the router was created.

description = None

The router description.

external_gateway_info = None

The network_id, for the external gateway. Type: dict

flavor_id = None

The ID of the flavor.

is_admin_state_up = None

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

is_distributed = None

The distributed state of the router, which is distributed True or not False. Type: bool Default: False

is_ha = None

The highly-available state of the router, which is highly available True or not False. Type: bool Default: False

name = None

The router name.

project_id = None

The ID of the project this router is associated with.

revision_number = None

Revision number of the router. Type: int

routes = None

The extra routes configuration for the router.

status = None

The router status.

updated_at = None

Timestamp when the router was created.

tags = None

A list of assocaited tags Type: list of tag strings

add_interface(session, **body)

Add an internal interface to a logical router.

Parameters:
  • session (Session) – The session to communicate through.
  • body (dict) – The body requested to be updated on the router
Returns:

The body of the response as a dictionary.
remove_interface(session, **body)

Remove an internal interface from a logical router.

Parameters:
  • session (Session) – The session to communicate through.
  • body (dict) – The body requested to be updated on the router
Returns:

The body of the response as a dictionary.
add_gateway(session, **body)

Add an external gateway to a logical router.

Parameters:
  • session (Session) – The session to communicate through.
  • body (dict) – The body requested to be updated on the router
Returns:

The body of the response as a dictionary.
remove_gateway(session, **body)

Remove an external gateway from a logical router.

Parameters:
  • session (Session) – The session to communicate through.
  • body (dict) – The body requested to be updated on the router
Returns:

The body of the response as a dictionary.