FarmNetworkInterfaceCardSettingsUpdateSpec

FarmNetworkInterfaceCardSettingsUpdateSpec
FarmNetworkInterfaceCardSettingsUpdateSpec

Network interface card settings for RDS Servers provisioned for the farm.

JSON Example
{
    "network_interface_card_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
    "network_label_assignment_specs": [
        {
            "enabled": true,
            "max_label": 1,
            "max_label_type": "LIMITED",
            "network_label_name": "vm-network"
        }
    ]
}
string
network_interface_card_id
Required

ID of the network interface card for these settings.

network_label_assignment_specs
Optional

Automatic network label assignment feature settings for this NIC. If network_label_assignment_specs is not set, nics will be ignored. By default, newly provisioned machines of an automated farm retain their parent image's network labels on each of their network interface cards. In certain circumstances, notably dealing with VLAN subset sizing and DHCP IP address availability, it may be desirable for the cloned VM to instead use different network labels for these newly provisioned machines. This feature allows an administrator to provide a per NIC list of network labels and their maximum availability to be automatically distributed to newly provisioned machines.
If this is not set, the feature is disabled.
Starting at the alphabetically first network label spec in the list that has not yet been assigned its maximum count for this NIC on this VM, the VM will have its next provisioned machine's NIC assigned that label. If all network labels in this list have reached their maximum count, this VM will have further provisioned machines assigned the last label in the list over capacity, and an error will be logged. Not all labels need be configured.
Any changes to these settings will be applicable only to RDS servers provisioned after the change. Already provisioned RDS servers will never have their network label assignments altered by this feature.