VsanVdsMigrationPlan

VsanVdsMigrationPlan
VsanVdsMigrationPlan

Migration plan from VSS to VDS.

Captures all aspects of the migration, i.e., the overall VDS specs, all portgroup specs and translations, as well as which consumers (pnics, vmknic and VM vNICs) are going to be migrated to their equivalent VDS portgroups. All migration plans always keep all settings for all consumers intact as part of the migration. If any issues occurred and how they were resolved is tracked within the plan.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "vdsSpec": {
        "_typeName": "string",
        "configSpec": {
            "_typeName": "string",
            "dynamicProperty": [
                {
                    "_typeName": "string",
                    "name": "string",
                    "val": {
                        "_typeName": "string"
                    }
                }
            ],
            "configVersion": "string",
            "name": "string",
            "numStandalonePorts": 0,
            "maxPorts": 0,
            "uplinkPortPolicy": {
                "_typeName": "string"
            },
            "uplinkPortgroup": [
                {
                    "_typeName": "string",
                    "type": "string",
                    "value": "string"
                }
            ],
            "defaultPortConfig": {
                "_typeName": "string",
                "blocked": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "vmDirectPathGen2Allowed": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "inShapingPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "enabled": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "averageBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "peakBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "burstSize": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    }
                },
                "outShapingPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "enabled": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "averageBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "peakBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "burstSize": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    }
                },
                "vendorSpecificConfig": {
                    "_typeName": "string",
                    "inherited": false,
                    "keyValue": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "opaqueData": "string"
                        }
                    ]
                },
                "networkResourcePoolKey": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": "string"
                },
                "filterPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "filterConfig": [
                        {
                            "_typeName": "string",
                            "inherited": false,
                            "key": "string",
                            "agentName": "string",
                            "slotNumber": "string",
                            "parameters": {
                                "_typeName": "string",
                                "parameters": [
                                    "string"
                                ]
                            },
                            "onFailure": "string"
                        }
                    ]
                }
            },
            "host": [
                {
                    "_typeName": "string",
                    "dynamicProperty": [
                        {
                            "_typeName": "string",
                            "name": "string",
                            "val": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "operation": "string",
                    "host": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "backing": {
                        "_typeName": "string"
                    },
                    "maxProxySwitchPorts": 0,
                    "vendorSpecificConfig": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "opaqueData": "string"
                        }
                    ]
                }
            ],
            "extensionKey": "string",
            "description": "string",
            "policy": {
                "_typeName": "string",
                "autoPreInstallAllowed": false,
                "autoUpgradeAllowed": false,
                "partialUpgradeAllowed": false
            },
            "vendorSpecificConfig": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "opaqueData": "string"
                }
            ],
            "contact": {
                "_typeName": "string",
                "name": "string",
                "contact": "string"
            },
            "switchIpAddress": "string",
            "defaultProxySwitchMaxNumPorts": 0,
            "infrastructureTrafficResourceConfig": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "description": "string",
                    "allocationInfo": {
                        "_typeName": "string",
                        "limit": 0,
                        "shares": {
                            "_typeName": "string",
                            "shares": 0,
                            "level": "string"
                        },
                        "reservation": 0
                    }
                }
            ],
            "netResourcePoolTrafficResourceConfig": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "description": "string",
                    "allocationInfo": {
                        "_typeName": "string",
                        "limit": 0,
                        "shares": {
                            "_typeName": "string",
                            "shares": 0,
                            "level": "string"
                        },
                        "reservation": 0
                    }
                }
            ],
            "networkResourceControlVersion": "string"
        },
        "productInfo": {
            "_typeName": "string",
            "name": "string",
            "vendor": "string",
            "version": "string",
            "build": "string",
            "forwardingClass": "string",
            "bundleId": "string",
            "bundleUrl": "string"
        },
        "capability": {
            "_typeName": "string",
            "dvsOperationSupported": false,
            "dvPortGroupOperationSupported": false,
            "dvPortOperationSupported": false,
            "compatibleHostComponentProductInfo": [
                {
                    "_typeName": "string",
                    "productLineId": "string",
                    "version": "string"
                }
            ],
            "featuresSupported": {
                "_typeName": "string",
                "networkResourceManagementSupported": false,
                "vmDirectPathGen2Supported": false,
                "nicTeamingPolicy": [
                    "string"
                ],
                "networkResourcePoolHighShareValue": 0,
                "networkResourceManagementCapability": {
                    "_typeName": "string",
                    "networkResourceManagementSupported": false,
                    "networkResourcePoolHighShareValue": 0,
                    "qosSupported": false,
                    "userDefinedNetworkResourcePoolsSupported": false,
                    "networkResourceControlVersion3Supported": false,
                    "userDefinedInfraTrafficPoolSupported": false
                },
                "healthCheckCapability": {
                    "_typeName": "string"
                },
                "rollbackCapability": {
                    "_typeName": "string",
                    "rollbackSupported": false
                },
                "backupRestoreCapability": {
                    "_typeName": "string",
                    "backupRestoreSupported": false
                },
                "networkFilterSupported": false,
                "macLearningSupported": false
            }
        }
    },
    "pgs": [
        {
            "_typeName": "string",
            "vssPgName": "string",
            "dvPgName": "string",
            "vdsPgSetting": {
                "_typeName": "string",
                "blocked": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "vmDirectPathGen2Allowed": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "inShapingPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "enabled": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "averageBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "peakBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "burstSize": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    }
                },
                "outShapingPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "enabled": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "averageBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "peakBandwidth": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    },
                    "burstSize": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": 0
                    }
                },
                "vendorSpecificConfig": {
                    "_typeName": "string",
                    "inherited": false,
                    "keyValue": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "opaqueData": "string"
                        }
                    ]
                },
                "networkResourcePoolKey": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": "string"
                },
                "filterPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "filterConfig": [
                        {
                            "_typeName": "string",
                            "inherited": false,
                            "key": "string",
                            "agentName": "string",
                            "slotNumber": "string",
                            "parameters": {
                                "_typeName": "string",
                                "parameters": [
                                    "string"
                                ]
                            },
                            "onFailure": "string"
                        }
                    ]
                },
                "vlan": {
                    "_typeName": "string",
                    "inherited": false
                },
                "qosTag": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "uplinkTeamingPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "policy": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": "string"
                    },
                    "reversePolicy": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "notifySwitches": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "rollingOrder": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "failureCriteria": {
                        "_typeName": "string",
                        "inherited": false,
                        "checkSpeed": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": "string"
                        },
                        "speed": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": 0
                        },
                        "checkDuplex": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": false
                        },
                        "fullDuplex": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": false
                        },
                        "checkErrorPercent": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": false
                        },
                        "percentage": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": 0
                        },
                        "checkBeacon": {
                            "_typeName": "string",
                            "inherited": false,
                            "value": false
                        }
                    },
                    "uplinkPortOrder": {
                        "_typeName": "string",
                        "inherited": false,
                        "activeUplinkPort": [
                            "string"
                        ],
                        "standbyUplinkPort": [
                            "string"
                        ]
                    }
                },
                "securityPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "allowPromiscuous": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "macChanges": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "forgedTransmits": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    }
                },
                "ipfixEnabled": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "txUplink": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "lacpPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "enable": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": false
                    },
                    "mode": {
                        "_typeName": "string",
                        "inherited": false,
                        "value": "string"
                    }
                },
                "macManagementPolicy": {
                    "_typeName": "string",
                    "inherited": false,
                    "allowPromiscuous": false,
                    "macChanges": false,
                    "forgedTransmits": false,
                    "macLearningPolicy": {
                        "_typeName": "string",
                        "inherited": false,
                        "enabled": false,
                        "allowUnicastFlooding": false,
                        "limit": 0,
                        "limitPolicy": "string"
                    }
                },
                "VNI": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                }
            },
            "vdsPgType": "string",
            "hosts": [
                {
                    "_typeName": "string",
                    "host": {
                        "_typeName": "string",
                        "type": "string",
                        "value": "string"
                    },
                    "hostname": "string",
                    "vmknicDevices": [
                        "string"
                    ],
                    "vmVnics": [
                        {
                            "_typeName": "string",
                            "vm": {
                                "_typeName": "string",
                                "type": "string",
                                "value": "string"
                            },
                            "vnicLabel": [
                                "string"
                            ]
                        }
                    ]
                }
            ],
            "collisionRename": false
        }
    ],
    "inaccessibleVms": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "infraVms": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ]
}
vdsSpec
Required

VDS creation spec.

Contains information about host members, and their pNICs.

pgs
Optional

Migration specs for all portgroups.

All policies are preserved for the consumers of these portgroups.

inaccessibleVms
Optional

A list of inaccessible or orphaned VMs which are blocking the migration.

infraVms
Optional

This is includes any infra VM which was explicitly provided by the user as well as possibly an auto-detected vCenter.

vCenter is auto-detected by comparing the IP of vCenter to the IP of VMs on the VSS, and if a match is found the VM is added to the list. Note that dependent VMs like an external VC DB, a DHCP or DNS server, or similar infrastructure VMs will not be auto-detected.