Vip

Manages a V1 load balancer vip resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var vip1 = new OpenStack.LoadBalancer.Vip("vip1", new OpenStack.LoadBalancer.VipArgs
        {
            PoolId = "67890",
            Port = 80,
            Protocol = "HTTP",
            SubnetId = "12345",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

vip1 = openstack.loadbalancer.Vip("vip1",
    pool_id="67890",
    port=80,
    protocol="HTTP",
    subnet_id="12345")

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

const vip1 = new openstack.loadbalancer.Vip("vip_1", {
    poolId: "67890",
    port: 80,
    protocol: "HTTP",
    subnetId: "12345",
});

Create a Vip Resource

new Vip(name: string, args: VipArgs, opts?: CustomResourceOptions);

def Vip(resource_name, opts=None, address=None, admin_state_up=None, conn_limit=None, description=None, floating_ip=None, name=None, persistence=None, pool_id=None, port=None, protocol=None, region=None, subnet_id=None, tenant_id=None, __props__=None);

func NewVip(ctx *Context, name string, args VipArgs, opts ...ResourceOption) (*Vip, error)

public Vip(string name, VipArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VipArgs: 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 VipArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Vip Resource Properties

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

Inputs

The Vip resource accepts the following input properties:

PoolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
Port int: The port on which to listen for client traffic. Changing this creates a new vip.
Protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
SubnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
Address string: The IP address of the vip. Changing this creates a new vip.
AdminStateUp bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
ConnLimit int: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
Description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
FloatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
Name string: The name of the vip. Changing this updates the name of the existing vip.
Persistence Dictionary<string, object>: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
TenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

PoolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
Port int: The port on which to listen for client traffic. Changing this creates a new vip.
Protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
SubnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
Address string: The IP address of the vip. Changing this creates a new vip.
AdminStateUp bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
ConnLimit int: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
Description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
FloatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
Name string: The name of the vip. Changing this updates the name of the existing vip.
Persistence map[string]interface{}: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
TenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

poolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
port number: The port on which to listen for client traffic. Changing this creates a new vip.
protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
subnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
address string: The IP address of the vip. Changing this creates a new vip.
adminStateUp boolean: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
connLimit number: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
floatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
name string: The name of the vip. Changing this updates the name of the existing vip.
persistence {[key: string]: any}: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
tenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

pool_id str: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
port float: The port on which to listen for client traffic. Changing this creates a new vip.
protocol str: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
subnet_id str: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
address str: The IP address of the vip. Changing this creates a new vip.
admin_state_up bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
conn_limit float: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
description str: Human-readable description for the vip. Changing this updates the description of the existing vip.
floating_ip str: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
name str: The name of the vip. Changing this updates the name of the existing vip.
persistence Dict[str, Any]: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
tenant_id str: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
PortId string: Port UUID for this VIP at associated floating IP (if any).

Id string: The provider-assigned unique ID for this managed resource.
PortId string: Port UUID for this VIP at associated floating IP (if any).

id string: The provider-assigned unique ID for this managed resource.
portId string: Port UUID for this VIP at associated floating IP (if any).

id str: The provider-assigned unique ID for this managed resource.
port_id str: Port UUID for this VIP at associated floating IP (if any).

Look up an Existing Vip Resource

Get an existing Vip 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?: VipState, opts?: CustomResourceOptions): Vip

static get(resource_name, id, opts=None, address=None, admin_state_up=None, conn_limit=None, description=None, floating_ip=None, name=None, persistence=None, pool_id=None, port=None, port_id=None, protocol=None, region=None, subnet_id=None, tenant_id=None, __props__=None);

func GetVip(ctx *Context, name string, id IDInput, state *VipState, opts ...ResourceOption) (*Vip, error)

public static Vip Get(string name, Input<string> id, VipState? 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 IP address of the vip. Changing this creates a new vip.
AdminStateUp bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
ConnLimit int: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
Description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
FloatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
Name string: The name of the vip. Changing this updates the name of the existing vip.
Persistence Dictionary<string, object>: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
PoolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
Port int: The port on which to listen for client traffic. Changing this creates a new vip.
PortId string: Port UUID for this VIP at associated floating IP (if any).
Protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
SubnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
TenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

Address string: The IP address of the vip. Changing this creates a new vip.
AdminStateUp bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
ConnLimit int: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
Description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
FloatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
Name string: The name of the vip. Changing this updates the name of the existing vip.
Persistence map[string]interface{}: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
PoolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
Port int: The port on which to listen for client traffic. Changing this creates a new vip.
PortId string: Port UUID for this VIP at associated floating IP (if any).
Protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
SubnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
TenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

address string: The IP address of the vip. Changing this creates a new vip.
adminStateUp boolean: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
connLimit number: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
description string: Human-readable description for the vip. Changing this updates the description of the existing vip.
floatingIp string: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
name string: The name of the vip. Changing this updates the name of the existing vip.
persistence {[key: string]: any}: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
poolId string: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
port number: The port on which to listen for client traffic. Changing this creates a new vip.
portId string: Port UUID for this VIP at associated floating IP (if any).
protocol string: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
subnetId string: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
tenantId string: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

address str: The IP address of the vip. Changing this creates a new vip.
admin_state_up bool: The administrative state of the vip. Acceptable values are “true” and “false”. Changing this value updates the state of the existing vip.
conn_limit float: The maximum number of connections allowed for the vip. Default is -1, meaning no limit. Changing this updates the conn_limit of the existing vip.
description str: Human-readable description for the vip. Changing this updates the description of the existing vip.
floating_ip str: A Networking Floating IP that will be associated with the vip. The Floating IP must be provisioned already.
name str: The name of the vip. Changing this updates the name of the existing vip.
persistence Dict[str, Any]: Omit this field to prevent session persistence. The persistence object structure is documented below. Changing this updates the persistence of the existing vip.
pool_id str: The ID of the pool with which the vip is associated. Changing this updates the pool_id of the existing vip.
port float: The port on which to listen for client traffic. Changing this creates a new vip.
port_id str: Port UUID for this VIP at associated floating IP (if any).
protocol str: The protocol - can be either ‘TCP, ‘HTTP’, or HTTPS’. Changing this creates a new vip.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VIP. If omitted, the region argument of the provider is used. Changing this creates a new VIP.
subnet_id str: The network on which to allocate the vip’s address. A tenant can only create vips on networks authorized by policy (e.g. networks that belong to them or networks that are shared). Changing this creates a new vip.
tenant_id str: The owner of the vip. Required if admin wants to create a vip member for another tenant. Changing this creates a new vip.

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

Vip