ControllerInterface

ControllerInterface
ControllerInterface
JSON Example
{
    "gateway": {
        "addr": "string",
        "type": "string"
    },
    "gateway6": {
        "addr": "string",
        "type": "string"
    },
    "if_name": "string",
    "ip": {
        "ip_addr": {
            "addr": "string",
            "type": "string"
        },
        "mask": 0
    },
    "ip6": {
        "ip_addr": {
            "addr": "string",
            "type": "string"
        },
        "mask": 0
    },
    "labels": [
        "string"
    ],
    "mac_address": "string",
    "mode": "string",
    "mode6": "string",
    "public_ip_or_name": {
        "addr": "string",
        "type": "string"
    },
    "v4_enabled": false,
    "v6_enabled": false
}
gateway
Optional

gateway

gateway6
Optional

gateway6

string
if_name
Optional

Interface name. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ip
Optional

ip

ip6
Optional

ip6

array of string
labels
Optional

Interface label like mgmt, secure channel or HSM. Enum options - MGMT, SE_SECURE_CHANNEL, HSM. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mac_address
Optional

Mac address of interface. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mode
Optional

IPv4 address mode DHCP/STATIC. Enum options - DHCP, STATIC, VIP, DOCKER_HOST, MODE_MANUAL. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mode6
Optional

IPv6 address mode STATIC. Enum options - DHCP, STATIC, VIP, DOCKER_HOST, MODE_MANUAL. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

public_ip_or_name
Optional

public_ip_or_name

boolean
v4_enabled
Optional

Enable V4 IP on this interface. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
v6_enabled
Optional

Enable V6 IP on this interface. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Property Of