FloatingIp

Manages a V2 floating IP resource within OpenStack Neutron (networking) that can be used for load balancers. These are similar to Nova (compute) floating IP resources, but only compute floating IPs can be used with compute instances.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var floatip1 = new OpenStack.Networking.FloatingIp("floatip1", new OpenStack.Networking.FloatingIpArgs
        {
            Pool = "public",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

floatip1 = openstack.networking.FloatingIp("floatip1", pool="public")

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const floatip1 = new openstack.networking.FloatingIp("floatip_1", {
    pool: "public",
});

Create a FloatingIp Resource

new FloatingIp(name: string, args: FloatingIpArgs, opts?: CustomResourceOptions);

def FloatingIp(resource_name, opts=None, address=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, pool=None, port_id=None, region=None, subnet_id=None, tags=None, tenant_id=None, value_specs=None, __props__=None);

func NewFloatingIp(ctx *Context, name string, args FloatingIpArgs, opts ...ResourceOption) (*FloatingIp, error)

public FloatingIp(string name, FloatingIpArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args FloatingIpArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FloatingIpArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FloatingIpArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

FloatingIp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The FloatingIp resource accepts the following input properties:

Pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
Address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
Description string: Human-readable description for the floating IP.
DnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
DnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
FixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
PortId string: ID of an existing port with at least one IP address to associate with this floating IP.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
SubnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
Tags List<string>: A set of string tags for the floating IP.
TenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
ValueSpecs Dictionary<string, object>: Map of additional options.

Pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
Address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
Description string: Human-readable description for the floating IP.
DnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
DnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
FixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
PortId string: ID of an existing port with at least one IP address to associate with this floating IP.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
SubnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
Tags []string: A set of string tags for the floating IP.
TenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
ValueSpecs map[string]interface{}: Map of additional options.

pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
description string: Human-readable description for the floating IP.
dnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
dnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
fixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
portId string: ID of an existing port with at least one IP address to associate with this floating IP.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
subnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
tags string[]: A set of string tags for the floating IP.
tenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
valueSpecs {[key: string]: any}: Map of additional options.

pool str: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
address str: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
description str: Human-readable description for the floating IP.
dns_domain str: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
dns_name str: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
fixed_ip str: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
port_id str: ID of an existing port with at least one IP address to associate with this floating IP.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
subnet_id str: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
tags List[str]: A set of string tags for the floating IP.
tenant_id str: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
value_specs Dict[str, Any]: Map of additional options.

Outputs

All input properties are implicitly available as output properties. Additionally, the FloatingIp resource produces the following output properties:

AllTags List<string>: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
Id string: The provider-assigned unique ID for this managed resource.

AllTags []string: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
Id string: The provider-assigned unique ID for this managed resource.

allTags string[]: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
id string: The provider-assigned unique ID for this managed resource.

all_tags List[str]: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing FloatingIp Resource

Get an existing FloatingIp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FloatingIpState, opts?: CustomResourceOptions): FloatingIp

static get(resource_name, id, opts=None, address=None, all_tags=None, description=None, dns_domain=None, dns_name=None, fixed_ip=None, pool=None, port_id=None, region=None, subnet_id=None, tags=None, tenant_id=None, value_specs=None, __props__=None);

func GetFloatingIp(ctx *Context, name string, id IDInput, state *FloatingIpState, opts ...ResourceOption) (*FloatingIp, error)

public static FloatingIp Get(string name, Input<string> id, FloatingIpState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
AllTags List<string>: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
Description string: Human-readable description for the floating IP.
DnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
DnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
FixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
Pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
PortId string: ID of an existing port with at least one IP address to associate with this floating IP.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
SubnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
Tags List<string>: A set of string tags for the floating IP.
TenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
ValueSpecs Dictionary<string, object>: Map of additional options.

Address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
AllTags []string: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
Description string: Human-readable description for the floating IP.
DnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
DnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
FixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
Pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
PortId string: ID of an existing port with at least one IP address to associate with this floating IP.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
SubnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
Tags []string: A set of string tags for the floating IP.
TenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
ValueSpecs map[string]interface{}: Map of additional options.

address string: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
allTags string[]: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
description string: Human-readable description for the floating IP.
dnsDomain string: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
dnsName string: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
fixedIp string: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
pool string: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
portId string: ID of an existing port with at least one IP address to associate with this floating IP.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
subnetId string: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
tags string[]: A set of string tags for the floating IP.
tenantId string: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
valueSpecs {[key: string]: any}: Map of additional options.

address str: The actual/specific floating IP to obtain. By default, non-admin users are not able to specify a floating IP, so you must either be an admin user or have had a custom policy or role applied to your OpenStack user or project.
all_tags List[str]: The collection of tags assigned on the floating IP, which have been explicitly and implicitly added.
description str: Human-readable description for the floating IP.
dns_domain str: The floating IP DNS domain. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
dns_name str: The floating IP DNS name. Available, when Neutron DNS extension is enabled. The data in this attribute will be published in an external DNS service when Neutron is configured to integrate with such a service. Changing this creates a new floating IP.
fixed_ip str: Fixed IP of the port to associate with this floating IP. Required if the port has multiple fixed IPs.
pool str: The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.
port_id str: ID of an existing port with at least one IP address to associate with this floating IP.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a floating IP that can be used with another networking resource, such as a load balancer. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).
subnet_id str: The subnet ID of the floating IP pool. Specify this if the floating IP network has multiple subnets.
tags List[str]: A set of string tags for the floating IP.
tenant_id str: The target tenant ID in which to allocate the floating IP, if you specify this together with a port_id, make sure the target port belongs to the same tenant. Changing this creates a new floating IP (which may or may not have a different address)
value_specs Dict[str, Any]: Map of additional options.

Package Details

Repository: https://github.com/pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud