nls_1.0_gateway | HCX Workload Migration APIs

nls_1.0_gateway

JSON Example

{
    "interfaces": [
        {
            "addressGroups": [
                "{}",
                "{}"
            ],
            "tunnelId": 2308,
            "backingNetworkId": "backingNetworkId",
            "isConnected": true,
            "name": "name",
            "networkName": "networkName",
            "parentInterfaceIndex": 5,
            "index": 600,
            "networkId": "networkId",
            "type": "uplink"
        },
        {
            "addressGroups": [
                "{}",
                "{}"
            ],
            "tunnelId": 2308,
            "backingNetworkId": "backingNetworkId",
            "isConnected": true,
            "name": "name",
            "networkName": "networkName",
            "parentInterfaceIndex": 5,
            "index": 600,
            "networkId": "networkId",
            "type": "uplink"
        },
        {
            "addressGroups": [
                "{}",
                "{}"
            ],
            "tunnelId": 2308,
            "backingNetworkId": "backingNetworkId",
            "isConnected": true,
            "name": "name",
            "networkName": "networkName",
            "parentInterfaceIndex": 5,
            "index": 600,
            "networkId": "networkId",
            "type": "uplink"
        },
        {
            "addressGroups": [
                "{}",
                "{}"
            ],
            "tunnelId": 2308,
            "backingNetworkId": "backingNetworkId",
            "isConnected": true,
            "name": "name",
            "networkName": "networkName",
            "parentInterfaceIndex": 5,
            "index": 600,
            "networkId": "networkId",
            "type": "uplink"
        },
        {
            "addressGroups": [
                "{}",
                "{}"
            ],
            "tunnelId": 2308,
            "backingNetworkId": "backingNetworkId",
            "isConnected": true,
            "name": "name",
            "networkName": "networkName",
            "parentInterfaceIndex": 5,
            "index": 600,
            "networkId": "networkId",
            "type": "uplink"
        }
    ],
    "scopeId": "scopeId",
    "vimId": "vimId",
    "enterprise": "enterprise",
    "scopeName": "scopeName",
    "description": "description",
    "syslogSettings": {
        "protocol": "udp",
        "serverAddresses": "{}",
        "version": 2,
        "enabled": true
    },
    "routingConfig": {
        "staticRouting": "{}"
    },
    "edgeId": "edgeId",
    "managedBy": "NLS",
    "edgeType": "edgeType",
    "organization": "organization",
    "cliSettings": {
        "password": "password",
        "passwordExpiry": "passwordExpiry",
        "remoteAccess": true,
        "userName": "userName",
        "sshLoginBannerText": "sshLoginBannerText"
    },
    "name": "name",
    "deploymentContainerType": "GLOBAL",
    "state": "NOT_REALIZED",
    "deploymentContainerId": "deploymentContainerId",
    "jobDetails": {
        "lastJobId": "lastJobId",
        "errorMessage": "errorMessage",
        "lastJobType": "lastJobType",
        "error": true
    },
    "haSettings": {
        "template": "template",
        "security": {
            "enabled": true
        },
        "vnic": "vnic",
        "declareDeadTime": 0,
        "logging": {
            "logLevel": "emergency",
            "enable": true
        },
        "ipAddresses": {
            "ipAddress": [
                "ipAddress",
                "ipAddress"
            ]
        },
        "zeroConfiguration": true,
        "version": 6,
        "enabled": true
    },
    "edgeVmSize": "compact",
    "objectId": "objectId"
}

nls_1.0_cliSettings

cliSettings

Optional

cliSettings

string

deploymentContainerId

Optional

Constraints: minLength: 49 maxLength: 49

deploymentContainerId

string

deploymentContainerType

Optional

deploymentContainerType

Possible values are : GLOBAL, LOCAL,

string

description

Optional

description

string

edgeId

Optional

edgeId

string

edgeType

Optional

edgeType

string

edgeVmSize

Optional

edgeVmSize

Possible values are : compact, large, quadlarge, xlarge,

string

enterprise

Optional

enterprise

nls_1.0_highAvailabilityConfigTrinity

haSettings

Optional

haSettings

array of nls_1.0_edgeInterface

interfaces

Required

Constraints: minItems: 1 maxItems: 10

interfaces

nls_1_0_gateway_jobDetails

jobDetails

Optional

jobDetails

string

managedBy

Optional

managedBy

Possible values are : NLS, VCD,

string

name

Required

name

string

objectId

Optional

Constraints: minLength: 44 maxLength: 44

objectId

string

organization

Optional

Constraints: maxLength: 36

organization

nls_1.0_routingConfig

routingConfig

Optional

routingConfig

string

scopeId

Optional

Constraints: minLength: 36 maxLength: 36

This is vCenterInstanceUUID. Can be obtained from /hybridity/api/compute

string

scopeName

Optional

scopeName

string

state

Optional

NOT-REALIZED - not created. REALIZED - created.

Possible values are : NOT_REALIZED, CREATE_IN_PROGRESS, IN_PROGRESS, REALIZED, DELETE_IN_PROGRESS, ERROR,

nls_1.0_syslogConfig

syslogSettings

Optional

syslogSettings

string

vimId

Optional

vimId