OpenStack v3.12.1, Mar 23 23

openstack.networking.PortForwardingV2

Manages a V2 portforwarding resource within OpenStack.

Example Usage

Simple portforwarding

using System.Collections.Generic;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var pf1 = new OpenStack.Networking.PortForwardingV2("pf1", new()
    {
        ExternalPort = 7233,
        FloatingipId = "7a52eb59-7d47-415d-a884-046666a6fbae",
        InternalPort = 25,
        InternalPortId = "b930d7f6-ceb7-40a0-8b81-a425dd994ccf",
        Protocol = "tcp",
    });

});

package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/networking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networking.NewPortForwardingV2(ctx, "pf1", &networking.PortForwardingV2Args{
			ExternalPort:   pulumi.Int(7233),
			FloatingipId:   pulumi.String("7a52eb59-7d47-415d-a884-046666a6fbae"),
			InternalPort:   pulumi.Int(25),
			InternalPortId: pulumi.String("b930d7f6-ceb7-40a0-8b81-a425dd994ccf"),
			Protocol:       pulumi.String("tcp"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.PortForwardingV2;
import com.pulumi.openstack.networking.PortForwardingV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pf1 = new PortForwardingV2("pf1", PortForwardingV2Args.builder()        
            .externalPort(7233)
            .floatingipId("7a52eb59-7d47-415d-a884-046666a6fbae")
            .internalPort(25)
            .internalPortId("b930d7f6-ceb7-40a0-8b81-a425dd994ccf")
            .protocol("tcp")
            .build());

    }
}

import pulumi
import pulumi_openstack as openstack

pf1 = openstack.networking.PortForwardingV2("pf1",
    external_port=7233,
    floatingip_id="7a52eb59-7d47-415d-a884-046666a6fbae",
    internal_port=25,
    internal_port_id="b930d7f6-ceb7-40a0-8b81-a425dd994ccf",
    protocol="tcp")

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

const pf1 = new openstack.networking.PortForwardingV2("pf1", {
    externalPort: 7233,
    floatingipId: "7a52eb59-7d47-415d-a884-046666a6fbae",
    internalPort: 25,
    internalPortId: "b930d7f6-ceb7-40a0-8b81-a425dd994ccf",
    protocol: "tcp",
});

resources:
  pf1:
    type: openstack:networking:PortForwardingV2
    properties:
      externalPort: 7233
      floatingipId: 7a52eb59-7d47-415d-a884-046666a6fbae
      internalPort: 25
      internalPortId: b930d7f6-ceb7-40a0-8b81-a425dd994ccf
      protocol: tcp

Create PortForwardingV2 Resource

new PortForwardingV2(name: string, args: PortForwardingV2Args, opts?: CustomResourceOptions);

@overload
def PortForwardingV2(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     external_port: Optional[int] = None,
                     floatingip_id: Optional[str] = None,
                     internal_ip_address: Optional[str] = None,
                     internal_port: Optional[int] = None,
                     internal_port_id: Optional[str] = None,
                     protocol: Optional[str] = None,
                     region: Optional[str] = None)
@overload
def PortForwardingV2(resource_name: str,
                     args: PortForwardingV2Args,
                     opts: Optional[ResourceOptions] = None)

func NewPortForwardingV2(ctx *Context, name string, args PortForwardingV2Args, opts ...ResourceOption) (*PortForwardingV2, error)

public PortForwardingV2(string name, PortForwardingV2Args args, CustomResourceOptions? opts = null)

public PortForwardingV2(String name, PortForwardingV2Args args)
public PortForwardingV2(String name, PortForwardingV2Args args, CustomResourceOptions options)

type: openstack:networking:PortForwardingV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

resource_name str: The unique name of the resource.
args PortForwardingV2Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args PortForwardingV2Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

PortForwardingV2 Resource Properties

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

Inputs

The PortForwardingV2 resource accepts the following input properties:

ExternalPort int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
FloatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
InternalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
InternalPort int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
InternalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
Protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
Description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

ExternalPort int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
FloatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
InternalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
InternalPort int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
InternalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
Protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
Description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

externalPort Integer: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId String: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress String: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort Integer: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId String: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol String: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
description String: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
region String: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

externalPort number: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort number: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

external_port int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingip_id str: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internal_ip_address str: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internal_port int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internal_port_id str: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol str: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
description str: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
region str: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

externalPort Number: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId String: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress String: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort Number: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId String: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol String: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
description String: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
region String: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing PortForwardingV2 Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        external_port: Optional[int] = None,
        floatingip_id: Optional[str] = None,
        internal_ip_address: Optional[str] = None,
        internal_port: Optional[int] = None,
        internal_port_id: Optional[str] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None) -> PortForwardingV2

func GetPortForwardingV2(ctx *Context, name string, id IDInput, state *PortForwardingV2State, opts ...ResourceOption) (*PortForwardingV2, error)

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

public static PortForwardingV2 get(String name, Output<String> id, PortForwardingV2State state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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:

Description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
ExternalPort int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
FloatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
InternalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
InternalPort int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
InternalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
Protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

Description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
ExternalPort int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
FloatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
InternalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
InternalPort int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
InternalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
Protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
Region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

description String: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
externalPort Integer: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId String: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress String: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort Integer: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId String: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol String: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
region String: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

description string: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
externalPort number: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId string: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress string: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort number: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId string: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol string: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
region string: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

description str: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
external_port int: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingip_id str: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internal_ip_address str: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internal_port int: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internal_port_id str: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol str: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
region str: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

description String: A text describing the port forwarding. Changing this updates the description of an existing port forwarding.
externalPort Number: The TCP/UDP/other protocol port number of the port forwarding. Changing this updates the external_port of an existing port forwarding.
floatingipId String: The ID of the Neutron floating IP address. Changing this creates a new port forwarding.
internalIpAddress String: The fixed IPv4 address of the Neutron port associated with the port forwarding. Changing this updates the internal_ip_address of an existing port forwarding.
internalPort Number: The TCP/UDP/other protocol port number of the Neutron port fixed IP address associated to the port forwarding. Changing this updates the internal_port of an existing port forwarding.
internalPortId String: The ID of the Neutron port associated with the port forwarding. Changing this updates the internal_port_id of an existing port forwarding.
protocol String: The IP protocol used in the port forwarding. Changing this updates the protocol of an existing port forwarding.
region String: The region in which to obtain the V2 networking client. A networking client is needed to create a port forwarding. If omitted, the region argument of the provider is used. Changing this creates a new port forwarding.

Package Details

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