openstack.network.v2.floating_ip¶
The FloatingIP Class¶
The FloatingIP
class inherits from Resource
.
- class openstack.network.v2.floating_ip.FloatingIP(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.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 = 'floatingip'¶
Singular form of key for resource.
- resources_key = 'floatingips'¶
Plural form of key for resource.
- base_path = '/floatingips'¶
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.
- created_at¶
Timestamp at which the floating IP was created.
- description¶
The floating IP description.
- dns_domain¶
The DNS domain.
- dns_name¶
The DNS name.
- fixed_ip_address¶
The fixed IP address associated with the floating IP. If you intend to associate the floating IP with a fixed IP at creation time, then you must indicate the identifier of the internal port. If an internal port has multiple associated IP addresses, the service chooses the first IP unless you explicitly specify the parameter fixed_ip_address to select a specific IP.
- floating_ip_address¶
The floating IP address.
- name¶
Floating IP object doesn’t have name attribute, set ip address to name so that user could find floating IP by UUID or IP address using find_ip
- floating_network_id¶
The ID of the network associated with the floating IP.
- port_details¶
Read-only. The details of the port that this floating IP associates with. Present if
fip-port-details
extension is loaded. Type: dict with keys: name, network_id, mac_address, admin_state_up, status, device_id, device_owner
- port_id¶
The port ID.
- qos_policy_id¶
The ID of the QoS policy attached to the floating IP.
- project_id¶
The ID of the project this floating IP is associated with.
- tenant_id¶
Tenant_id (deprecated attribute).
- router_id¶
The ID of an associated router.
- status¶
The floating IP status. Value is
ACTIVE
orDOWN
.
- updated_at¶
Timestamp at which the floating IP was last updated.
- subnet_id¶
The Subnet ID associated with the floating IP.