openstack.network.v2.router¶
The Router Class¶
The Router
class inherits from Resource
.
-
class
openstack.network.v2.router.
Router
(attrs=None, loaded=False)¶ Construct a Resource to interact with a service’s REST API.
The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See
Resource.new()
andResource.existing()
.Parameters: - attrs (dict) – The attributes to set when constructing this Resource.
- loaded (bool) –
True
if this Resource exists on the server,False
if it does not.
-
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
-
is_admin_state_up
= None¶ The administrative state of the router, which is up
True
or downFalse
. Type: bool
-
is_distributed
= None¶ The distributed state of the router, which is distributed
True
or notFalse
. Type: bool Default: False
-
is_ha
= None¶ The highly-available state of the router, which is highly available
True
or notFalse
. 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 last updated.
-
add_interface
(session, **body)¶ Add an internal interface to a logical router.
Parameters: session ( Session
) – The session to communicate through.:param dict body : The body requested to be updated on the outer
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.:param dict body : The body requested to be updated on the outer
Returns: The body of the response as a dictionary.