Get Network Config Profiles

Get Network Profiles

Get network profiles compatible with the storage type and hosts subject to installation.

Request

URI

POST

https://{api_host}/v1/sddcs/network-config-profiles

COPY

Request Body

SddcNetworkConfigProfileSpec of type(s) application/json

Required

Show optional properties

{
    "storageType": "string",
    "hostSpecs": [
        {
            "hostname": "esx-1"
        }
    ]
}

{
    "storageType": "string",
    "hostSpecs": [
        {
            "hostname": "esx-1",
            "credentials": {
                "username": "root",
                "password": "string"
            },
            "sshThumbprint": "SHA256:rVPNWOKE2tZjvmYvKPhtc3ghJ41Vc0G3MwASf4+8+yc",
            "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
        }
    ],
    "subdomain": "vcf.vmware.com",
    "nsxConfigType": "One among: NSX_SEPARATION, NO_NSX_SEPARATION",
    "additionalPortGroups": [
        "[FLEET_MANAGEMENT]"
    ]
}

string

storageType

Required

Storage type of the Management Domain

Possible values are : VSAN, VSAN_ESA, NFS, FC,

array of object

hostSpecs

Required

List of hosts which will be used for the Management Domain

string

subdomain

Optional

Tenant Sub domain. Includes the full domain suffix

string As (NSX_SEPARATION|NO_NSX_SEPARATION)

nsxConfigType

Optional

NSX Config Type

array of string

additionalPortGroups

Optional

Additional port groups that are to be included. 0 or more of the allowed values can be included. Allowed values: FLEET_MANAGEMENT

Responses

200

Returns SddcNetworkConfigProfileResponse of type(s) application/json

{
    "commonPhysicalNics": [
        {
            "deviceName": "string",
            "speedMb": 0,
            "isSmartNic": false,
            "smartNic": false
        }
    ],
    "profiles": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "dvsSpecs": [
                {
                    "dvsName": "VdsName",
                    "networks": [
                        "MANAGEMENT"
                    ],
                    "mtu": 9000,
                    "nsxtSwitchConfig": {
                        "transportZones": [
                            {
                                "name": "string",
                                "transportType": "One among: VLAN, OVERLAY"
                            }
                        ],
                        "hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT",
                        "ipAssignmentType": "string"
                    },
                    "vmnicsToUplinks": [
                        {
                            "id": "vmnic0",
                            "uplink": "uplink1"
                        }
                    ],
                    "nsxTeamings": [
                        {
                            "policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
                            "activeUplinks": [
                                "string"
                            ],
                            "standByUplinks": [
                                "string"
                            ]
                        }
                    ],
                    "lagSpecs": [
                        {
                            "name": "string",
                            "uplinksCount": 0,
                            "lacpMode": "One among:ACTIVE, PASSIVE",
                            "loadBalancingMode": "One among:SOURCE_MAC, DESTINATION_MAC, SOURCE_AND_DESTINATION_MAC, DESTINATION_IP_AND_VLAN, SOURCE_IP_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_VLAN, DESTINATION_TCP_UDP_PORT, SOURCE_TCP_UDP_PORT, SOURCE_AND_DESTINATION_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT, SOURCE_IP_AND_TCP_UDP_PORT, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, DESTINATION_IP, SOURCE_IP, SOURCE_AND_DESTINATION_IP, VLAN, SOURCE_PORT_ID",
                            "lacpTimeoutMode": "One among:SLOW, FAST"
                        }
                    ]
                }
            ],
            "dvsNameToPortgroupSpecs": {
                "dvsNameToPortgroupSpecs": [
                    {
                        "networkType": "MANAGEMENT",
                        "subnet": "10.0.0.250/24",
                        "gateway": "10.0.0.250",
                        "subnetMask": "255.255.255.0",
                        "includeIpAddress": [
                            "[10.0.0.100]"
                        ],
                        "includeIpAddressRanges": [
                            {
                                "startIpAddress": "192.168.0.123",
                                "endIpAddress": "192.168.0.128"
                            }
                        ],
                        "vlanId": 1000,
                        "mtu": 0,
                        "teamingPolicy": "loadbalance_ip",
                        "activeUplinks": [
                            "string"
                        ],
                        "standbyUplinks": [
                            "string"
                        ],
                        "portGroupKey": "string",
                        "ipAddressVersion": "IPv6",
                        "ipAddressAssignmentMode": "SLAAC"
                    }
                ]
            }
        }
    ]
}

array of object

commonPhysicalNics

Optional

List of physical NICs common to all hosts.

array of object

profiles

Optional

List of pre-configured network profiles

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "notifications": [
        {
            "severity": "string",
            "message": "string",
            "remediations": [
                {
                    "message": "string",
                    "link": "string"
                }
            ],
            "impactMessage": "string"
        }
    ],
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        {
            "errorCode": "string",
            "errorType": "string",
            "arguments": [
                "string"
            ],
            "context": {
                "context": "string"
            },
            "notifications": [
                {
                    "severity": "string",
                    "message": "string",
                    "remediations": [
                        {
                            "message": "string",
                            "link": "string"
                        }
                    ],
                    "impactMessage": "string"
                }
            ],
            "message": "string",
            "remediationMessage": "string",
            "causes": [
                {
                    "type": "string",
                    "message": "string"
                }
            ],
            "nestedErrors": [
                "Error Object"
            ],
            "referenceToken": "string",
            "label": "string",
            "remediationUrl": "string"
        }
    ],
    "referenceToken": "string",
    "label": "string",
    "remediationUrl": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

array of object

notifications

Optional

Detailed results of the precheck validation.

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of object

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string

label

Optional

The localized label message

string

remediationUrl

Optional

The URL string for remediation documentation link

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostSpecs":["object"],"storageType":"string"}' https://{api_host}/v1/sddcs/network-config-profiles

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Vcf Installer Operations