Skip to content

NetworkInterfaceProps

Properties for defining a NetworkInterface.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-networkinterface

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ecs;
new NetworkInterfaceProps {
    object VSwitchId,
    object DeleteOnRelease = null,
    object Description = null,
    object Ipv4PrefixCount = null,
    object Ipv4Prefixes = null,
    object Ipv6AddressCount = null,
    object Ipv6Addresses = null,
    object Ipv6PrefixCount = null,
    object Ipv6Prefixes = null,
    object NetworkInterfaceName = null,
    object NetworkInterfaceTrafficMode = null,
    object PrimaryIpAddress = null,
    object PrivateIpAddresses = null,
    object QueueNumber = null,
    object ResourceGroupId = null,
    object RxQueueSize = null,
    object SecondaryPrivateIpAddressCount = null,
    object SecurityGroupId = null,
    object SecurityGroupIds = null,
    TagsProperty[] Tags = null,
    object TxQueueSize = null
};

Properties

Name Type Description
VSwitchId object Property vSwitchId: VSwitch ID of the specified VPC.
DeleteOnRelease object Property deleteOnRelease: Specifies whether to delete the ENI when the instance is released.
Description object Property description: Description of your ENI.
Ipv4PrefixCount object Property ipv4PrefixCount: Specifies one or more IPv4 prefixes for the elastic network interface.
Ipv4Prefixes object Property ipv4Prefixes: Specifies one or more IPv4 prefixes for the elastic network interface.
Ipv6AddressCount object Property ipv6AddressCount: The number of randomly generated IPv6 addresses that are assigned to the ENI.
Ipv6Addresses object Property ipv6Addresses: The IPv6 address N to assign to the ENI.
Ipv6PrefixCount object Property ipv6PrefixCount: Specifies one or more IPv6 prefixes for the elastic network interface.
Ipv6Prefixes object Property ipv6Prefixes: Specifies one or more IPv6 prefixes for the elastic network interface.
NetworkInterfaceName object Property networkInterfaceName: Name of your ENI.
NetworkInterfaceTrafficMode object Property networkInterfaceTrafficMode: The communication mode of the ENI.
PrimaryIpAddress object Property primaryIpAddress: The primary private IP address of the ENI.
PrivateIpAddresses object Property privateIpAddresses: Specifies secondary private IP addresses of the ENI.
QueueNumber object Property queueNumber: The number of queues that are supported by the ENI.
ResourceGroupId object Property resourceGroupId: Resource group id.
RxQueueSize object Property rxQueueSize: Elastic network card inbound queue depth.
SecondaryPrivateIpAddressCount object Property secondaryPrivateIpAddressCount: The number of private IP addresses that can be created automatically by ECS.
SecurityGroupId object Property securityGroupId: The ID of the security group that the ENI joins.
SecurityGroupIds object Property securityGroupIds: The IDs of the security groups that the ENI joins.
Tags TagsProperty[] Property tags: Tags to attach to instance.
TxQueueSize object Property txQueueSize: Elastic network card outbound queue depth.

VSwitchIdRequired

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: VSwitch ID of the specified VPC.

Specifies the switch ID for the VPC.


DeleteOnReleaseOptional

public object DeleteOnRelease { get; set; }
  • Type: object

Property deleteOnRelease: Specifies whether to delete the ENI when the instance is released.


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: Description of your ENI.

It is a string of [2, 256] English or Chinese characters.


Ipv4PrefixCountOptional

public object Ipv4PrefixCount { get; set; }
  • Type: object

Property ipv4PrefixCount: Specifies one or more IPv4 prefixes for the elastic network interface.

Range: 1-10 Note: If you need to set an IPv4 prefix for an elastic network interface, you must set either Ipv4Prefixes or Ipv4PrefixCount, but not both.


Ipv4PrefixesOptional

public object Ipv4Prefixes { get; set; }
  • Type: object

Property ipv4Prefixes: Specifies one or more IPv4 prefixes for the elastic network interface.


Ipv6AddressCountOptional

public object Ipv6AddressCount { get; set; }
  • Type: object

Property ipv6AddressCount: The number of randomly generated IPv6 addresses that are assigned to the ENI.


Ipv6AddressesOptional

public object Ipv6Addresses { get; set; }
  • Type: object

Property ipv6Addresses: The IPv6 address N to assign to the ENI.


Ipv6PrefixCountOptional

public object Ipv6PrefixCount { get; set; }
  • Type: object

Property ipv6PrefixCount: Specifies one or more IPv6 prefixes for the elastic network interface.

Range: 1-10 Note: If you need to set an IPv6 prefix for an elastic network interface, you must set either Ipv6Prefixes or Ipv6PrefixCount, but not both.


Ipv6PrefixesOptional

public object Ipv6Prefixes { get; set; }
  • Type: object

Property ipv6Prefixes: Specifies one or more IPv6 prefixes for the elastic network interface.


NetworkInterfaceNameOptional

public object NetworkInterfaceName { get; set; }
  • Type: object

Property networkInterfaceName: Name of your ENI.

It is a string of [2, 128] Chinese or English characters. It must begin with a letter and can contain numbers, underscores (_), colons (:), or hyphens (-).


NetworkInterfaceTrafficModeOptional

public object NetworkInterfaceTrafficMode { get; set; }
  • Type: object

Property networkInterfaceTrafficMode: The communication mode of the ENI.

Valid values: Standard: uses the TCP communication mode. HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the remote direct memory access (RDMA) communication mode.


PrimaryIpAddressOptional

public object PrimaryIpAddress { get; set; }
  • Type: object

Property primaryIpAddress: The primary private IP address of the ENI.

The specified IP address must have the same Host ID as the VSwitch. If no IP addresses are specified, a random network ID is assigned for the ENI.


PrivateIpAddressesOptional

public object PrivateIpAddresses { get; set; }
  • Type: object

Property privateIpAddresses: Specifies secondary private IP addresses of the ENI.

This IP address must be an available IP address in the CIDR block of the VSwitch to which the ENI belongs.


QueueNumberOptional

public object QueueNumber { get; set; }
  • Type: object

Property queueNumber: The number of queues that are supported by the ENI.

Valid values: 1 to 2048. When you attach the ENI to an instance, make sure that the value of this parameter is less than the maximum number of queues per ENI that is allowed for the instance type. To view the maximum number of queues per ENI allowed for an instance type, you can call DescribeInstanceTypes and then check the return value of MaximumQueueNumberPerEni. By default, this parameter is empty. If you do not specify this parameter, the default number of queues per ENI for the instance type of an instance is used when you attach the ENI to the instance. To learn about the default number of queues per ENI for an instance type, you can call DescribeInstanceTypes and then check the return value of SecondaryEniQueueNumber.


ResourceGroupIdOptional

public object ResourceGroupId { get; set; }
  • Type: object

Property resourceGroupId: Resource group id.


RxQueueSizeOptional

public object RxQueueSize { get; set; }
  • Type: object

Property rxQueueSize: Elastic network card inbound queue depth.

Note: The inbound queue depth of the network card must be equal to the outbound queue depth, ranging from 8192 to 16384, and must be a power of two. Larger inbound queue depth can improve inbound throughput, but it consumes more memory.


SecondaryPrivateIpAddressCountOptional

public object SecondaryPrivateIpAddressCount { get; set; }
  • Type: object

Property secondaryPrivateIpAddressCount: The number of private IP addresses that can be created automatically by ECS.


SecurityGroupIdOptional

public object SecurityGroupId { get; set; }
  • Type: object

Property securityGroupId: The ID of the security group that the ENI joins.

The security group and the ENI must be in a same VPC.


SecurityGroupIdsOptional

public object SecurityGroupIds { get; set; }
  • Type: object

Property securityGroupIds: The IDs of the security groups that the ENI joins.

The security groups and the ENI must belong to the same VPC.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


TxQueueSizeOptional

public object TxQueueSize { get; set; }
  • Type: object

Property txQueueSize: Elastic network card outbound queue depth.

Note: The outbound queue depth of the network card must be equal to the inbound queue depth, ranging from 8192 to 16384, and must be a power of two. Larger outbound queue depth can improve outbound throughput, but it consumes more memory.