Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. NetworkingPort
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.NetworkingPort

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

Manages a port resource within VKCS.

Example Usage

Simple port

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

const persistentEtcd = new vkcs.NetworkingPort("persistentEtcd", {
    networkId: vkcs_networking_network.db.id,
    fixedIps: [{
        subnetId: vkcs_networking_subnet.db.id,
    }],
    fullSecurityGroupsControl: true,
    securityGroupIds: [vkcs_networking_secgroup.etcd.id],
    tags: [
        "tf-example",
        "etcd",
    ],
}, {
    dependsOn: [vkcs_networking_router_interface.db],
});
Copy
import pulumi
import pulumi_vkcs as vkcs

persistent_etcd = vkcs.NetworkingPort("persistentEtcd",
    network_id=vkcs_networking_network["db"]["id"],
    fixed_ips=[{
        "subnet_id": vkcs_networking_subnet["db"]["id"],
    }],
    full_security_groups_control=True,
    security_group_ids=[vkcs_networking_secgroup["etcd"]["id"]],
    tags=[
        "tf-example",
        "etcd",
    ],
    opts = pulumi.ResourceOptions(depends_on=[vkcs_networking_router_interface["db"]]))
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewNetworkingPort(ctx, "persistentEtcd", &vkcs.NetworkingPortArgs{
			NetworkId: pulumi.Any(vkcs_networking_network.Db.Id),
			FixedIps: vkcs.NetworkingPortFixedIpArray{
				&vkcs.NetworkingPortFixedIpArgs{
					SubnetId: pulumi.Any(vkcs_networking_subnet.Db.Id),
				},
			},
			FullSecurityGroupsControl: pulumi.Bool(true),
			SecurityGroupIds: pulumi.StringArray{
				vkcs_networking_secgroup.Etcd.Id,
			},
			Tags: pulumi.StringArray{
				pulumi.String("tf-example"),
				pulumi.String("etcd"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			vkcs_networking_router_interface.Db,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var persistentEtcd = new Vkcs.NetworkingPort("persistentEtcd", new()
    {
        NetworkId = vkcs_networking_network.Db.Id,
        FixedIps = new[]
        {
            new Vkcs.Inputs.NetworkingPortFixedIpArgs
            {
                SubnetId = vkcs_networking_subnet.Db.Id,
            },
        },
        FullSecurityGroupsControl = true,
        SecurityGroupIds = new[]
        {
            vkcs_networking_secgroup.Etcd.Id,
        },
        Tags = new[]
        {
            "tf-example",
            "etcd",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vkcs_networking_router_interface.Db,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.NetworkingPort;
import com.pulumi.vkcs.NetworkingPortArgs;
import com.pulumi.vkcs.inputs.NetworkingPortFixedIpArgs;
import com.pulumi.resources.CustomResourceOptions;
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 persistentEtcd = new NetworkingPort("persistentEtcd", NetworkingPortArgs.builder()
            .networkId(vkcs_networking_network.db().id())
            .fixedIps(NetworkingPortFixedIpArgs.builder()
                .subnetId(vkcs_networking_subnet.db().id())
                .build())
            .fullSecurityGroupsControl(true)
            .securityGroupIds(vkcs_networking_secgroup.etcd().id())
            .tags(            
                "tf-example",
                "etcd")
            .build(), CustomResourceOptions.builder()
                .dependsOn(vkcs_networking_router_interface.db())
                .build());

    }
}
Copy
resources:
  persistentEtcd:
    type: vkcs:NetworkingPort
    properties:
      networkId: ${vkcs_networking_network.db.id}
      # Specify subnet for multi subnet networks to controls
      #   # which subnet is used to get port IP
      #   # Also this brings you required dependency of the port
      #   # Otherwise if you create the port with network and subnet
      #   # in one tf file the port may be created before the subnet
      #   # So it does not get IP
      #   # Alternative for this case is to set subnet dependency
      #   # explicitly
      fixedIps:
        - subnetId: ${vkcs_networking_subnet.db.id}
      # Set this argument to true always
      fullSecurityGroupsControl: true
      # Specify required security groups instead of getting 'default' one
      securityGroupIds:
        - ${vkcs_networking_secgroup.etcd.id}
      tags:
        - tf-example
        - etcd
    options:
      dependsOn:
        - ${vkcs_networking_router_interface.db}
Copy

Notes

Ports and Instances

There are some notes to consider when connecting Instances to networks using Ports. Please see the vkcs.ComputeInstance documentation for further documentation.

Create NetworkingPort Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NetworkingPort(name: string, args: NetworkingPortArgs, opts?: CustomResourceOptions);
@overload
def NetworkingPort(resource_name: str,
                   args: NetworkingPortArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def NetworkingPort(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   network_id: Optional[str] = None,
                   name: Optional[str] = None,
                   networking_port_id: Optional[str] = None,
                   device_id: Optional[str] = None,
                   device_owner: Optional[str] = None,
                   dns_name: Optional[str] = None,
                   extra_dhcp_options: Optional[Sequence[NetworkingPortExtraDhcpOptionArgs]] = None,
                   fixed_ips: Optional[Sequence[NetworkingPortFixedIpArgs]] = None,
                   full_security_groups_control: Optional[bool] = None,
                   mac_address: Optional[str] = None,
                   admin_state_up: Optional[bool] = None,
                   description: Optional[str] = None,
                   no_fixed_ip: Optional[bool] = None,
                   allowed_address_pairs: Optional[Sequence[NetworkingPortAllowedAddressPairArgs]] = None,
                   no_security_groups: Optional[bool] = None,
                   port_security_enabled: Optional[bool] = None,
                   region: Optional[str] = None,
                   sdn: Optional[str] = None,
                   security_group_ids: Optional[Sequence[str]] = None,
                   tags: Optional[Sequence[str]] = None,
                   timeouts: Optional[NetworkingPortTimeoutsArgs] = None,
                   value_specs: Optional[Mapping[str, str]] = None)
func NewNetworkingPort(ctx *Context, name string, args NetworkingPortArgs, opts ...ResourceOption) (*NetworkingPort, error)
public NetworkingPort(string name, NetworkingPortArgs args, CustomResourceOptions? opts = null)
public NetworkingPort(String name, NetworkingPortArgs args)
public NetworkingPort(String name, NetworkingPortArgs args, CustomResourceOptions options)

type: vkcs:NetworkingPort
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NetworkingPortArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NetworkingPortArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkingPortArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NetworkingPortArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NetworkingPortArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var networkingPortResource = new Vkcs.NetworkingPort("networkingPortResource", new()
{
    NetworkId = "string",
    Name = "string",
    NetworkingPortId = "string",
    DeviceId = "string",
    DeviceOwner = "string",
    DnsName = "string",
    ExtraDhcpOptions = new[]
    {
        new Vkcs.Inputs.NetworkingPortExtraDhcpOptionArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    FixedIps = new[]
    {
        new Vkcs.Inputs.NetworkingPortFixedIpArgs
        {
            SubnetId = "string",
            IpAddress = "string",
        },
    },
    FullSecurityGroupsControl = false,
    MacAddress = "string",
    AdminStateUp = false,
    Description = "string",
    NoFixedIp = false,
    AllowedAddressPairs = new[]
    {
        new Vkcs.Inputs.NetworkingPortAllowedAddressPairArgs
        {
            IpAddress = "string",
            MacAddress = "string",
        },
    },
    PortSecurityEnabled = false,
    Region = "string",
    Sdn = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Vkcs.Inputs.NetworkingPortTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    ValueSpecs = 
    {
        { "string", "string" },
    },
});
Copy
example, err := vkcs.NewNetworkingPort(ctx, "networkingPortResource", &vkcs.NetworkingPortArgs{
NetworkId: pulumi.String("string"),
Name: pulumi.String("string"),
NetworkingPortId: pulumi.String("string"),
DeviceId: pulumi.String("string"),
DeviceOwner: pulumi.String("string"),
DnsName: pulumi.String("string"),
ExtraDhcpOptions: .NetworkingPortExtraDhcpOptionArray{
&.NetworkingPortExtraDhcpOptionArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
FixedIps: .NetworkingPortFixedIpArray{
&.NetworkingPortFixedIpArgs{
SubnetId: pulumi.String("string"),
IpAddress: pulumi.String("string"),
},
},
FullSecurityGroupsControl: pulumi.Bool(false),
MacAddress: pulumi.String("string"),
AdminStateUp: pulumi.Bool(false),
Description: pulumi.String("string"),
NoFixedIp: pulumi.Bool(false),
AllowedAddressPairs: .NetworkingPortAllowedAddressPairArray{
&.NetworkingPortAllowedAddressPairArgs{
IpAddress: pulumi.String("string"),
MacAddress: pulumi.String("string"),
},
},
PortSecurityEnabled: pulumi.Bool(false),
Region: pulumi.String("string"),
Sdn: pulumi.String("string"),
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.NetworkingPortTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
ValueSpecs: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
Copy
var networkingPortResource = new NetworkingPort("networkingPortResource", NetworkingPortArgs.builder()
    .networkId("string")
    .name("string")
    .networkingPortId("string")
    .deviceId("string")
    .deviceOwner("string")
    .dnsName("string")
    .extraDhcpOptions(NetworkingPortExtraDhcpOptionArgs.builder()
        .name("string")
        .value("string")
        .build())
    .fixedIps(NetworkingPortFixedIpArgs.builder()
        .subnetId("string")
        .ipAddress("string")
        .build())
    .fullSecurityGroupsControl(false)
    .macAddress("string")
    .adminStateUp(false)
    .description("string")
    .noFixedIp(false)
    .allowedAddressPairs(NetworkingPortAllowedAddressPairArgs.builder()
        .ipAddress("string")
        .macAddress("string")
        .build())
    .portSecurityEnabled(false)
    .region("string")
    .sdn("string")
    .securityGroupIds("string")
    .tags("string")
    .timeouts(NetworkingPortTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .valueSpecs(Map.of("string", "string"))
    .build());
Copy
networking_port_resource = vkcs.NetworkingPort("networkingPortResource",
    network_id="string",
    name="string",
    networking_port_id="string",
    device_id="string",
    device_owner="string",
    dns_name="string",
    extra_dhcp_options=[{
        "name": "string",
        "value": "string",
    }],
    fixed_ips=[{
        "subnet_id": "string",
        "ip_address": "string",
    }],
    full_security_groups_control=False,
    mac_address="string",
    admin_state_up=False,
    description="string",
    no_fixed_ip=False,
    allowed_address_pairs=[{
        "ip_address": "string",
        "mac_address": "string",
    }],
    port_security_enabled=False,
    region="string",
    sdn="string",
    security_group_ids=["string"],
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
    },
    value_specs={
        "string": "string",
    })
Copy
const networkingPortResource = new vkcs.NetworkingPort("networkingPortResource", {
    networkId: "string",
    name: "string",
    networkingPortId: "string",
    deviceId: "string",
    deviceOwner: "string",
    dnsName: "string",
    extraDhcpOptions: [{
        name: "string",
        value: "string",
    }],
    fixedIps: [{
        subnetId: "string",
        ipAddress: "string",
    }],
    fullSecurityGroupsControl: false,
    macAddress: "string",
    adminStateUp: false,
    description: "string",
    noFixedIp: false,
    allowedAddressPairs: [{
        ipAddress: "string",
        macAddress: "string",
    }],
    portSecurityEnabled: false,
    region: "string",
    sdn: "string",
    securityGroupIds: ["string"],
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
    },
    valueSpecs: {
        string: "string",
    },
});
Copy
type: vkcs:NetworkingPort
properties:
    adminStateUp: false
    allowedAddressPairs:
        - ipAddress: string
          macAddress: string
    description: string
    deviceId: string
    deviceOwner: string
    dnsName: string
    extraDhcpOptions:
        - name: string
          value: string
    fixedIps:
        - ipAddress: string
          subnetId: string
    fullSecurityGroupsControl: false
    macAddress: string
    name: string
    networkId: string
    networkingPortId: string
    noFixedIp: false
    portSecurityEnabled: false
    region: string
    sdn: string
    securityGroupIds:
        - string
    tags:
        - string
    timeouts:
        create: string
        delete: string
    valueSpecs:
        string: string
Copy

NetworkingPort Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NetworkingPort resource accepts the following input properties:

NetworkId This property is required. string
required string → The ID of the network to attach the port to. Changing this creates a new port.
AdminStateUp bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
AllowedAddressPairs List<NetworkingPortAllowedAddressPair>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
Description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
DeviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
DeviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
DnsName string
optional string → The port DNS name.
ExtraDhcpOptions List<NetworkingPortExtraDhcpOption>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
FixedIps List<NetworkingPortFixedIp>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
FullSecurityGroupsControl bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
MacAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
Name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
NetworkingPortId string
string → ID of the resource.
NoFixedIp bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
NoSecurityGroups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

PortSecurityEnabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
Region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
Sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
SecurityGroupIds List<string>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
Tags List<string>
optional set of string → A set of string tags for the port.
Timeouts NetworkingPortTimeouts
ValueSpecs Dictionary<string, string>
optional map of string → Map of additional options.
NetworkId This property is required. string
required string → The ID of the network to attach the port to. Changing this creates a new port.
AdminStateUp bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
AllowedAddressPairs []NetworkingPortAllowedAddressPairArgs
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
Description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
DeviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
DeviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
DnsName string
optional string → The port DNS name.
ExtraDhcpOptions []NetworkingPortExtraDhcpOptionArgs
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
FixedIps []NetworkingPortFixedIpArgs
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
FullSecurityGroupsControl bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
MacAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
Name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
NetworkingPortId string
string → ID of the resource.
NoFixedIp bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
NoSecurityGroups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

PortSecurityEnabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
Region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
Sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
SecurityGroupIds []string
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
Tags []string
optional set of string → A set of string tags for the port.
Timeouts NetworkingPortTimeoutsArgs
ValueSpecs map[string]string
optional map of string → Map of additional options.
networkId This property is required. String
required string → The ID of the network to attach the port to. Changing this creates a new port.
adminStateUp Boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allowedAddressPairs List<NetworkingPortAllowedAddressPair>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description String
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId String
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner String
optional string → The device owner of the port. Changing this creates a new port.
dnsName String
optional string → The port DNS name.
extraDhcpOptions List<NetworkingPortExtraDhcpOption>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps List<NetworkingPortFixedIp>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl Boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress String
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name String
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkingPortId String
string → ID of the resource.
noFixedIp Boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups Boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled Boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region String
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn String
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds List<String>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags List<String>
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeouts
valueSpecs Map<String,String>
optional map of string → Map of additional options.
networkId This property is required. string
required string → The ID of the network to attach the port to. Changing this creates a new port.
adminStateUp boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allowedAddressPairs NetworkingPortAllowedAddressPair[]
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
dnsName string
optional string → The port DNS name.
extraDhcpOptions NetworkingPortExtraDhcpOption[]
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps NetworkingPortFixedIp[]
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkingPortId string
string → ID of the resource.
noFixedIp boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds string[]
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags string[]
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeouts
valueSpecs {[key: string]: string}
optional map of string → Map of additional options.
network_id This property is required. str
required string → The ID of the network to attach the port to. Changing this creates a new port.
admin_state_up bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allowed_address_pairs Sequence[NetworkingPortAllowedAddressPairArgs]
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description str
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
device_id str
optional string → The ID of the device attached to the port. Changing this creates a new port.
device_owner str
optional string → The device owner of the port. Changing this creates a new port.
dns_name str
optional string → The port DNS name.
extra_dhcp_options Sequence[NetworkingPortExtraDhcpOptionArgs]
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixed_ips Sequence[NetworkingPortFixedIpArgs]
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
full_security_groups_control bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
mac_address str
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name str
optional string → A unique name for the port. Changing this updates the name of an existing port.
networking_port_id str
string → ID of the resource.
no_fixed_ip bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
no_security_groups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

port_security_enabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region str
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn str
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
security_group_ids Sequence[str]
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags Sequence[str]
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeoutsArgs
value_specs Mapping[str, str]
optional map of string → Map of additional options.
networkId This property is required. String
required string → The ID of the network to attach the port to. Changing this creates a new port.
adminStateUp Boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allowedAddressPairs List<Property Map>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description String
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId String
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner String
optional string → The device owner of the port. Changing this creates a new port.
dnsName String
optional string → The port DNS name.
extraDhcpOptions List<Property Map>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps List<Property Map>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl Boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress String
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name String
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkingPortId String
string → ID of the resource.
noFixedIp Boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups Boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled Boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region String
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn String
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds List<String>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags List<String>
optional set of string → A set of string tags for the port.
timeouts Property Map
valueSpecs Map<String>
optional map of string → Map of additional options.

Outputs

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

AllFixedIps List<string>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
AllSecurityGroupIds List<string>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

AllTags List<string>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
DnsAssignments List<ImmutableDictionary<string, string>>
map of string → The list of maps representing port DNS assignments.
Id string
The provider-assigned unique ID for this managed resource.
AllFixedIps []string
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
AllSecurityGroupIds []string
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

AllTags []string
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
DnsAssignments []map[string]string
map of string → The list of maps representing port DNS assignments.
Id string
The provider-assigned unique ID for this managed resource.
allFixedIps List<String>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds List<String>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags List<String>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
dnsAssignments List<Map<String,String>>
map of string → The list of maps representing port DNS assignments.
id String
The provider-assigned unique ID for this managed resource.
allFixedIps string[]
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds string[]
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags string[]
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
dnsAssignments {[key: string]: string}[]
map of string → The list of maps representing port DNS assignments.
id string
The provider-assigned unique ID for this managed resource.
all_fixed_ips Sequence[str]
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
all_security_group_ids Sequence[str]
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

all_tags Sequence[str]
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
dns_assignments Sequence[Mapping[str, str]]
map of string → The list of maps representing port DNS assignments.
id str
The provider-assigned unique ID for this managed resource.
allFixedIps List<String>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds List<String>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags List<String>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
dnsAssignments List<Map<String>>
map of string → The list of maps representing port DNS assignments.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing NetworkingPort Resource

Get an existing NetworkingPort 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?: NetworkingPortState, opts?: CustomResourceOptions): NetworkingPort
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        all_fixed_ips: Optional[Sequence[str]] = None,
        all_security_group_ids: Optional[Sequence[str]] = None,
        all_tags: Optional[Sequence[str]] = None,
        allowed_address_pairs: Optional[Sequence[NetworkingPortAllowedAddressPairArgs]] = None,
        description: Optional[str] = None,
        device_id: Optional[str] = None,
        device_owner: Optional[str] = None,
        dns_assignments: Optional[Sequence[Mapping[str, str]]] = None,
        dns_name: Optional[str] = None,
        extra_dhcp_options: Optional[Sequence[NetworkingPortExtraDhcpOptionArgs]] = None,
        fixed_ips: Optional[Sequence[NetworkingPortFixedIpArgs]] = None,
        full_security_groups_control: Optional[bool] = None,
        mac_address: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        networking_port_id: Optional[str] = None,
        no_fixed_ip: Optional[bool] = None,
        no_security_groups: Optional[bool] = None,
        port_security_enabled: Optional[bool] = None,
        region: Optional[str] = None,
        sdn: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[NetworkingPortTimeoutsArgs] = None,
        value_specs: Optional[Mapping[str, str]] = None) -> NetworkingPort
func GetNetworkingPort(ctx *Context, name string, id IDInput, state *NetworkingPortState, opts ...ResourceOption) (*NetworkingPort, error)
public static NetworkingPort Get(string name, Input<string> id, NetworkingPortState? state, CustomResourceOptions? opts = null)
public static NetworkingPort get(String name, Output<String> id, NetworkingPortState state, CustomResourceOptions options)
resources:  _:    type: vkcs:NetworkingPort    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AdminStateUp bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
AllFixedIps List<string>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
AllSecurityGroupIds List<string>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

AllTags List<string>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
AllowedAddressPairs List<NetworkingPortAllowedAddressPair>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
Description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
DeviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
DeviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
DnsAssignments List<ImmutableDictionary<string, string>>
map of string → The list of maps representing port DNS assignments.
DnsName string
optional string → The port DNS name.
ExtraDhcpOptions List<NetworkingPortExtraDhcpOption>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
FixedIps List<NetworkingPortFixedIp>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
FullSecurityGroupsControl bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
MacAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
Name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
NetworkId string
required string → The ID of the network to attach the port to. Changing this creates a new port.
NetworkingPortId string
string → ID of the resource.
NoFixedIp bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
NoSecurityGroups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

PortSecurityEnabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
Region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
Sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
SecurityGroupIds List<string>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
Tags List<string>
optional set of string → A set of string tags for the port.
Timeouts NetworkingPortTimeouts
ValueSpecs Dictionary<string, string>
optional map of string → Map of additional options.
AdminStateUp bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
AllFixedIps []string
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
AllSecurityGroupIds []string
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

AllTags []string
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
AllowedAddressPairs []NetworkingPortAllowedAddressPairArgs
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
Description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
DeviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
DeviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
DnsAssignments []map[string]string
map of string → The list of maps representing port DNS assignments.
DnsName string
optional string → The port DNS name.
ExtraDhcpOptions []NetworkingPortExtraDhcpOptionArgs
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
FixedIps []NetworkingPortFixedIpArgs
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
FullSecurityGroupsControl bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
MacAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
Name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
NetworkId string
required string → The ID of the network to attach the port to. Changing this creates a new port.
NetworkingPortId string
string → ID of the resource.
NoFixedIp bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
NoSecurityGroups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

PortSecurityEnabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
Region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
Sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
SecurityGroupIds []string
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
Tags []string
optional set of string → A set of string tags for the port.
Timeouts NetworkingPortTimeoutsArgs
ValueSpecs map[string]string
optional map of string → Map of additional options.
adminStateUp Boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allFixedIps List<String>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds List<String>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags List<String>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
allowedAddressPairs List<NetworkingPortAllowedAddressPair>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description String
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId String
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner String
optional string → The device owner of the port. Changing this creates a new port.
dnsAssignments List<Map<String,String>>
map of string → The list of maps representing port DNS assignments.
dnsName String
optional string → The port DNS name.
extraDhcpOptions List<NetworkingPortExtraDhcpOption>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps List<NetworkingPortFixedIp>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl Boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress String
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name String
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkId String
required string → The ID of the network to attach the port to. Changing this creates a new port.
networkingPortId String
string → ID of the resource.
noFixedIp Boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups Boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled Boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region String
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn String
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds List<String>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags List<String>
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeouts
valueSpecs Map<String,String>
optional map of string → Map of additional options.
adminStateUp boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allFixedIps string[]
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds string[]
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags string[]
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
allowedAddressPairs NetworkingPortAllowedAddressPair[]
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description string
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId string
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner string
optional string → The device owner of the port. Changing this creates a new port.
dnsAssignments {[key: string]: string}[]
map of string → The list of maps representing port DNS assignments.
dnsName string
optional string → The port DNS name.
extraDhcpOptions NetworkingPortExtraDhcpOption[]
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps NetworkingPortFixedIp[]
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress string
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name string
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkId string
required string → The ID of the network to attach the port to. Changing this creates a new port.
networkingPortId string
string → ID of the resource.
noFixedIp boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region string
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn string
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds string[]
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags string[]
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeouts
valueSpecs {[key: string]: string}
optional map of string → Map of additional options.
admin_state_up bool
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
all_fixed_ips Sequence[str]
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
all_security_group_ids Sequence[str]
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

all_tags Sequence[str]
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
allowed_address_pairs Sequence[NetworkingPortAllowedAddressPairArgs]
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description str
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
device_id str
optional string → The ID of the device attached to the port. Changing this creates a new port.
device_owner str
optional string → The device owner of the port. Changing this creates a new port.
dns_assignments Sequence[Mapping[str, str]]
map of string → The list of maps representing port DNS assignments.
dns_name str
optional string → The port DNS name.
extra_dhcp_options Sequence[NetworkingPortExtraDhcpOptionArgs]
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixed_ips Sequence[NetworkingPortFixedIpArgs]
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
full_security_groups_control bool
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
mac_address str
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name str
optional string → A unique name for the port. Changing this updates the name of an existing port.
network_id str
required string → The ID of the network to attach the port to. Changing this creates a new port.
networking_port_id str
string → ID of the resource.
no_fixed_ip bool
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
no_security_groups bool
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

port_security_enabled bool
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region str
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn str
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
security_group_ids Sequence[str]
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags Sequence[str]
optional set of string → A set of string tags for the port.
timeouts NetworkingPortTimeoutsArgs
value_specs Mapping[str, str]
optional map of string → Map of additional options.
adminStateUp Boolean
optional boolean → Administrative up/down status for the port (must be true or false if provided). Changing this updates the admin_state_up of an existing port.
allFixedIps List<String>
string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
allSecurityGroupIds List<String>
set of string → The collection of security group IDs on the port which have been explicitly and implicitly added. Deprecated Use security_group_ids together with full_security_groups_control = true instead.

Deprecated: Deprecated

allTags List<String>
set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
allowedAddressPairs List<Property Map>
optional → An IP/MAC Address pair of additional IP addresses that can be active on this port. The structure is described below.
description String
optional string → Human-readable description of the port. Changing this updates the description of an existing port.
deviceId String
optional string → The ID of the device attached to the port. Changing this creates a new port.
deviceOwner String
optional string → The device owner of the port. Changing this creates a new port.
dnsAssignments List<Map<String>>
map of string → The list of maps representing port DNS assignments.
dnsName String
optional string → The port DNS name.
extraDhcpOptions List<Property Map>
optional → An extra DHCP option that needs to be configured on the port. The structure is described below. Can be specified multiple times. Note: This is field is not supported by sprut sdn.
fixedIps List<Property Map>
optional → (Conflicts with no_fixed_ip) An array of desired IPs for this port. The structure is described below.
fullSecurityGroupsControl Boolean
optional boolean → Always set this argument to true. It brings consistent behavior of managing of security groups of the port. See description of security_group_ids argument. Note: This argument is introduced to seamless migration to the consistent behavior and will get true by default in new major version of the provider.New since v0.8.0.
macAddress String
optional string → Specify a specific MAC address for the port. Changing this creates a new port.
name String
optional string → A unique name for the port. Changing this updates the name of an existing port.
networkId String
required string → The ID of the network to attach the port to. Changing this creates a new port.
networkingPortId String
string → ID of the resource.
noFixedIp Boolean
optional boolean → (Conflicts with fixed_ip) Create a port with no fixed IP address. This will also remove any fixed IPs previously set on a port. true is the only valid value for this argument.
noSecurityGroups Boolean
optional deprecated boolean → If set to true, then no security groups are applied to the port. If set to false and no security_group_ids are specified, then the port will yield to the default behavior of the Networking service, which is to usually apply the "default" security group. Deprecated Configure full_security_groups_control = true and security_group_ids = [] instead.

Deprecated: Deprecated

portSecurityEnabled Boolean
optional boolean → Whether to explicitly enable or disable port security on the port. Port Security is usually enabled by default, so omitting argument will usually result in a value of true. Setting this explicitly to false will disable port security. In order to disable port security, the port must not have any security groups. Valid values are true and false.
region String
optional string → The region in which to obtain the Networking client. A Networking client is needed to create a port. If omitted, the region argument of the provider is used. Changing this creates a new port.
sdn String
optional string → SDN to use for this resource. Must be one of following: "neutron", "sprut". Default value is project's default SDN.
securityGroupIds List<String>
optional set of string → A list of security group IDs to apply to the port. The security groups must be specified by ID and not name. If the list is empty then no one security group is attached to the port. If the argument is absent then vkcs.NetworkingPort resource does not control security groups of the port and just reads them from Networking service. The last case yields to the default behavior of the Networking service, which adds the "default" security group. Note: This behavior is actual with full_security_groups_control = true only and introduced in 0.8.0 version of the provider. Legacy behavior is still supported but deprecated and too confusing to be described.
tags List<String>
optional set of string → A set of string tags for the port.
timeouts Property Map
valueSpecs Map<String>
optional map of string → Map of additional options.

Supporting Types

NetworkingPortAllowedAddressPair
, NetworkingPortAllowedAddressPairArgs

IpAddress This property is required. string
required string → The additional IP address.
MacAddress string
optional string → The additional MAC address.
IpAddress This property is required. string
required string → The additional IP address.
MacAddress string
optional string → The additional MAC address.
ipAddress This property is required. String
required string → The additional IP address.
macAddress String
optional string → The additional MAC address.
ipAddress This property is required. string
required string → The additional IP address.
macAddress string
optional string → The additional MAC address.
ip_address This property is required. str
required string → The additional IP address.
mac_address str
optional string → The additional MAC address.
ipAddress This property is required. String
required string → The additional IP address.
macAddress String
optional string → The additional MAC address.

NetworkingPortExtraDhcpOption
, NetworkingPortExtraDhcpOptionArgs

Name This property is required. string
required string → Name of the DHCP option.
Value This property is required. string
required string → Value of the DHCP option.
Name This property is required. string
required string → Name of the DHCP option.
Value This property is required. string
required string → Value of the DHCP option.
name This property is required. String
required string → Name of the DHCP option.
value This property is required. String
required string → Value of the DHCP option.
name This property is required. string
required string → Name of the DHCP option.
value This property is required. string
required string → Value of the DHCP option.
name This property is required. str
required string → Name of the DHCP option.
value This property is required. str
required string → Value of the DHCP option.
name This property is required. String
required string → Name of the DHCP option.
value This property is required. String
required string → Value of the DHCP option.

NetworkingPortFixedIp
, NetworkingPortFixedIpArgs

SubnetId This property is required. string
required string → Subnet in which to allocate IP address for this port.
IpAddress string
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.
SubnetId This property is required. string
required string → Subnet in which to allocate IP address for this port.
IpAddress string
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.
subnetId This property is required. String
required string → Subnet in which to allocate IP address for this port.
ipAddress String
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.
subnetId This property is required. string
required string → Subnet in which to allocate IP address for this port.
ipAddress string
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.
subnet_id This property is required. str
required string → Subnet in which to allocate IP address for this port.
ip_address str
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.
subnetId This property is required. String
required string → Subnet in which to allocate IP address for this port.
ipAddress String
optional string → IP address desired in the subnet for this port. If you don't specify ip_address, an available IP address from the specified subnet will be allocated to this port. This field will not be populated if it is left blank or omitted. To retrieve the assigned IP address, use the all_fixed_ips attribute.

NetworkingPortTimeouts
, NetworkingPortTimeoutsArgs

Create string
Delete string
Create string
Delete string
create String
delete String
create string
delete string
create str
delete str
create String
delete String

Import

Ports can be imported using the id, e.g.

$ pulumi import vkcs:index/networkingPort:NetworkingPort port_1 eae26a3e-1c33-4cc1-9c31-0cd729c438a1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs