vkcs.NetworkingPort
Explore with Pulumi AI
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],
});
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"]]))
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
})
}
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,
},
});
});
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());
}
}
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}
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 string
- The unique name of the resource.
- args NetworkingPortArgs
- 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 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 string
- The unique name of the resource.
- args NetworkingPortArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkingPortArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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" },
},
});
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: vkcs.NetworkingPortExtraDhcpOptionArray{
&vkcs.NetworkingPortExtraDhcpOptionArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
FixedIps: vkcs.NetworkingPortFixedIpArray{
&vkcs.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: vkcs.NetworkingPortAllowedAddressPairArray{
&vkcs.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: &vkcs.NetworkingPortTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
ValueSpecs: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
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());
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",
})
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",
},
});
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
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:
- Network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- Admin
State boolUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - Allowed
Address List<NetworkingPairs Port Allowed Address Pair> - 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. - Device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- Device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- Dns
Name string - optional string → The port DNS name.
- Extra
Dhcp List<NetworkingOptions Port Extra Dhcp Option> - 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 List<NetworkingPort Fixed Ip> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - Full
Security boolGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - Mac
Address 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. - Networking
Port stringId - string → ID of the resource.
- No
Fixed boolIp - 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 boolGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - Port
Security boolEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- Security
Group List<string>Ids - 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 withfull_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. - List<string>
- optional set of string → A set of string tags for the port.
- Timeouts
Networking
Port Timeouts - Value
Specs Dictionary<string, string> - optional map of string → Map of additional options.
- Network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- Admin
State boolUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - Allowed
Address []NetworkingPairs Port Allowed Address Pair Args - 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. - Device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- Device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- Dns
Name string - optional string → The port DNS name.
- Extra
Dhcp []NetworkingOptions Port Extra Dhcp Option Args - 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 []NetworkingPort Fixed Ip Args - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - Full
Security boolGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - Mac
Address 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. - Networking
Port stringId - string → ID of the resource.
- No
Fixed boolIp - 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 boolGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - Port
Security boolEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- Security
Group []stringIds - 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 withfull_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. - []string
- optional set of string → A set of string tags for the port.
- Timeouts
Networking
Port Timeouts Args - Value
Specs map[string]string - optional map of string → Map of additional options.
- network
Id String - required string → The ID of the network to attach the port to. Changing this creates a new port.
- admin
State BooleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - allowed
Address List<NetworkingPairs Port Allowed Address Pair> - 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. - device
Id String - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner String - optional string → The device owner of the port. Changing this creates a new port.
- dns
Name String - optional string → The port DNS name.
- extra
Dhcp List<NetworkingOptions Port Extra Dhcp Option> - 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 List<NetworkingPort Fixed Ip> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security BooleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - networking
Port StringId - string → ID of the resource.
- no
Fixed BooleanIp - 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 BooleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security BooleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group List<String>Ids - 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 withfull_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. - List<String>
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts - value
Specs Map<String,String> - optional map of string → Map of additional options.
- network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- admin
State booleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - allowed
Address NetworkingPairs Port Allowed Address Pair[] - 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. - device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- dns
Name string - optional string → The port DNS name.
- extra
Dhcp NetworkingOptions Port Extra Dhcp Option[] - 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 NetworkingPort Fixed Ip[] - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security booleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - networking
Port stringId - string → ID of the resource.
- no
Fixed booleanIp - 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 booleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security booleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group string[]Ids - 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 withfull_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. - string[]
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts - value
Specs {[key: string]: string} - optional map of string → Map of additional options.
- network_
id str - required string → The ID of the network to attach the port to. Changing this creates a new port.
- admin_
state_ boolup - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - allowed_
address_ Sequence[Networkingpairs Port Allowed Address Pair Args] - 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_ Sequence[Networkingoptions Port Extra Dhcp Option Args] - 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[NetworkingPort Fixed Ip Args] - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full_
security_ boolgroups_ control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
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_ strid - string → ID of the resource.
- no_
fixed_ boolip - 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_ boolgroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port_
security_ boolenabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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_ Sequence[str]ids - 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 withfull_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. - Sequence[str]
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts Args - value_
specs Mapping[str, str] - optional map of string → Map of additional options.
- network
Id String - required string → The ID of the network to attach the port to. Changing this creates a new port.
- admin
State BooleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - allowed
Address List<Property Map>Pairs - 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. - device
Id String - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner String - optional string → The device owner of the port. Changing this creates a new port.
- dns
Name String - optional string → The port DNS name.
- extra
Dhcp List<Property Map>Options - 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 List<Property Map> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security BooleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - networking
Port StringId - string → ID of the resource.
- no
Fixed BooleanIp - 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 BooleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security BooleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group List<String>Ids - 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 withfull_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. - List<String>
- optional set of string → A set of string tags for the port.
- timeouts Property Map
- value
Specs 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:
- All
Fixed List<string>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- All
Security List<string>Group Ids - 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 withfull_security_groups_control = true
instead. - List<string>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- Dns
Assignments 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.
- All
Fixed []stringIps - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- All
Security []stringGroup Ids - 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 withfull_security_groups_control = true
instead. - []string
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- Dns
Assignments []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.
- all
Fixed List<String>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security List<String>Group Ids - 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 withfull_security_groups_control = true
instead. - List<String>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- dns
Assignments 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.
- all
Fixed string[]Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security string[]Group Ids - 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 withfull_security_groups_control = true
instead. - string[]
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- dns
Assignments {[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_ Sequence[str]ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all_
security_ Sequence[str]group_ ids - 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 withfull_security_groups_control = true
instead. - 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.
- all
Fixed List<String>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security List<String>Group Ids - 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 withfull_security_groups_control = true
instead. - List<String>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- dns
Assignments 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
- 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.
- Admin
State boolUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - All
Fixed List<string>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- All
Security List<string>Group Ids - 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 withfull_security_groups_control = true
instead. - List<string>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- Allowed
Address List<NetworkingPairs Port Allowed Address Pair> - 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. - Device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- Device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- Dns
Assignments List<ImmutableDictionary<string, string>> - map of string → The list of maps representing port DNS assignments.
- Dns
Name string - optional string → The port DNS name.
- Extra
Dhcp List<NetworkingOptions Port Extra Dhcp Option> - 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 List<NetworkingPort Fixed Ip> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - Full
Security boolGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - Mac
Address 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. - Network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- Networking
Port stringId - string → ID of the resource.
- No
Fixed boolIp - 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 boolGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - Port
Security boolEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- Security
Group List<string>Ids - 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 withfull_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. - List<string>
- optional set of string → A set of string tags for the port.
- Timeouts
Networking
Port Timeouts - Value
Specs Dictionary<string, string> - optional map of string → Map of additional options.
- Admin
State boolUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - All
Fixed []stringIps - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- All
Security []stringGroup Ids - 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 withfull_security_groups_control = true
instead. - []string
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- Allowed
Address []NetworkingPairs Port Allowed Address Pair Args - 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. - Device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- Device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- Dns
Assignments []map[string]string - map of string → The list of maps representing port DNS assignments.
- Dns
Name string - optional string → The port DNS name.
- Extra
Dhcp []NetworkingOptions Port Extra Dhcp Option Args - 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 []NetworkingPort Fixed Ip Args - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - Full
Security boolGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - Mac
Address 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. - Network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- Networking
Port stringId - string → ID of the resource.
- No
Fixed boolIp - 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 boolGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - Port
Security boolEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- Security
Group []stringIds - 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 withfull_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. - []string
- optional set of string → A set of string tags for the port.
- Timeouts
Networking
Port Timeouts Args - Value
Specs map[string]string - optional map of string → Map of additional options.
- admin
State BooleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - all
Fixed List<String>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security List<String>Group Ids - 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 withfull_security_groups_control = true
instead. - List<String>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- allowed
Address List<NetworkingPairs Port Allowed Address Pair> - 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. - device
Id String - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner String - optional string → The device owner of the port. Changing this creates a new port.
- dns
Assignments List<Map<String,String>> - map of string → The list of maps representing port DNS assignments.
- dns
Name String - optional string → The port DNS name.
- extra
Dhcp List<NetworkingOptions Port Extra Dhcp Option> - 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 List<NetworkingPort Fixed Ip> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security BooleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - network
Id String - required string → The ID of the network to attach the port to. Changing this creates a new port.
- networking
Port StringId - string → ID of the resource.
- no
Fixed BooleanIp - 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 BooleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security BooleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group List<String>Ids - 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 withfull_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. - List<String>
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts - value
Specs Map<String,String> - optional map of string → Map of additional options.
- admin
State booleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - all
Fixed string[]Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security string[]Group Ids - 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 withfull_security_groups_control = true
instead. - string[]
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- allowed
Address NetworkingPairs Port Allowed Address Pair[] - 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. - device
Id string - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner string - optional string → The device owner of the port. Changing this creates a new port.
- dns
Assignments {[key: string]: string}[] - map of string → The list of maps representing port DNS assignments.
- dns
Name string - optional string → The port DNS name.
- extra
Dhcp NetworkingOptions Port Extra Dhcp Option[] - 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 NetworkingPort Fixed Ip[] - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security booleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - network
Id string - required string → The ID of the network to attach the port to. Changing this creates a new port.
- networking
Port stringId - string → ID of the resource.
- no
Fixed booleanIp - 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 booleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security booleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group string[]Ids - 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 withfull_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. - string[]
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts - value
Specs {[key: string]: string} - optional map of string → Map of additional options.
- admin_
state_ boolup - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - all_
fixed_ Sequence[str]ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all_
security_ Sequence[str]group_ ids - 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 withfull_security_groups_control = true
instead. - Sequence[str]
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- allowed_
address_ Sequence[Networkingpairs Port Allowed Address Pair Args] - 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_ Sequence[Networkingoptions Port Extra Dhcp Option Args] - 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[NetworkingPort Fixed Ip Args] - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full_
security_ boolgroups_ control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
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_ strid - string → ID of the resource.
- no_
fixed_ boolip - 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_ boolgroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port_
security_ boolenabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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_ Sequence[str]ids - 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 withfull_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. - Sequence[str]
- optional set of string → A set of string tags for the port.
- timeouts
Networking
Port Timeouts Args - value_
specs Mapping[str, str] - optional map of string → Map of additional options.
- admin
State BooleanUp - optional boolean → Administrative up/down status for the port (must be
true
orfalse
if provided). Changing this updates theadmin_state_up
of an existing port. - all
Fixed List<String>Ips - string → The collection of Fixed IP addresses on the port in the order returned by the Network v2 API.
- all
Security List<String>Group Ids - 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 withfull_security_groups_control = true
instead. - List<String>
- set of string → The collection of tags assigned on the port, which have been explicitly and implicitly added.
- allowed
Address List<Property Map>Pairs - 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. - device
Id String - optional string → The ID of the device attached to the port. Changing this creates a new port.
- device
Owner String - optional string → The device owner of the port. Changing this creates a new port.
- dns
Assignments List<Map<String>> - map of string → The list of maps representing port DNS assignments.
- dns
Name String - optional string → The port DNS name.
- extra
Dhcp List<Property Map>Options - 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 List<Property Map> - optional → (Conflicts with
no_fixed_ip
) An array of desired IPs for this port. The structure is described below. - full
Security BooleanGroups Control - optional boolean → Always set this argument to
true
. It brings consistent behavior of managing of security groups of the port. See description ofsecurity_group_ids
argument. Note: This argument is introduced to seamless migration to the consistent behavior and will gettrue
by default in new major version of the provider.New since v0.8.0. - mac
Address 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. - network
Id String - required string → The ID of the network to attach the port to. Changing this creates a new port.
- networking
Port StringId - string → ID of the resource.
- no
Fixed BooleanIp - 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 BooleanGroups - optional deprecated boolean → If set to
true
, then no security groups are applied to the port. If set tofalse
and nosecurity_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 Configurefull_security_groups_control = true
andsecurity_group_ids = []
instead. - port
Security BooleanEnabled - 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 tofalse
will disable port security. In order to disable port security, the port must not have any security groups. Valid values aretrue
andfalse
. - 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.
- security
Group List<String>Ids - 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 withfull_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. - List<String>
- optional set of string → A set of string tags for the port.
- timeouts Property Map
- value
Specs Map<String> - optional map of string → Map of additional options.
Supporting Types
NetworkingPortAllowedAddressPair, NetworkingPortAllowedAddressPairArgs
- Ip
Address string - required string → The additional IP address.
- Mac
Address string - optional string → The additional MAC address.
- Ip
Address string - required string → The additional IP address.
- Mac
Address string - optional string → The additional MAC address.
- ip
Address String - required string → The additional IP address.
- mac
Address String - optional string → The additional MAC address.
- ip
Address string - required string → The additional IP address.
- mac
Address string - optional string → The additional MAC address.
- ip_
address str - required string → The additional IP address.
- mac_
address str - optional string → The additional MAC address.
- ip
Address String - required string → The additional IP address.
- mac
Address String - optional string → The additional MAC address.
NetworkingPortExtraDhcpOption, NetworkingPortExtraDhcpOptionArgs
NetworkingPortFixedIp, NetworkingPortFixedIpArgs
- Subnet
Id string - required string → Subnet in which to allocate IP address for this port.
- Ip
Address 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 theall_fixed_ips
attribute.
- Subnet
Id string - required string → Subnet in which to allocate IP address for this port.
- Ip
Address 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 theall_fixed_ips
attribute.
- subnet
Id String - required string → Subnet in which to allocate IP address for this port.
- ip
Address 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 theall_fixed_ips
attribute.
- subnet
Id string - required string → Subnet in which to allocate IP address for this port.
- ip
Address 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 theall_fixed_ips
attribute.
- subnet_
id 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 theall_fixed_ips
attribute.
- subnet
Id String - required string → Subnet in which to allocate IP address for this port.
- ip
Address 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 theall_fixed_ips
attribute.
NetworkingPortTimeouts, NetworkingPortTimeoutsArgs
Import
Ports can be imported using the id
, e.g.
$ pulumi import vkcs:index/networkingPort:NetworkingPort port_1 eae26a3e-1c33-4cc1-9c31-0cd729c438a1
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.