NSX-T Data Center Global Manager REST API

ConfigOnboardingRequest (type)

{
  "additionalProperties": false,
  "description": "Config onboarding request to initiate onboarding workflow on global manager for a site.",
  "id": "ConfigOnboardingRequest",
  "module_id": "GmConfigOnboarding",
  "properties": {
    "prefix": {
      "description": "User provided prefix string to resolve conflicting site entities.",
      "readonly": true,
      "required": false,
      "title": "Prefix string",
      "type": "string"
    },
    "site_backup_reference": {
      "description": "Site backup image details to hint user to restore site before starting onboarding process. Users must use the listing API to view available backups and select one. If no backups exist, create one first and then use it in the API request.",
      "readonly": true,
      "required": true,
      "title": "Site Backup Reference",
      "type": "string"
    },
    "site_id": {
      "description": "Site Id.",
      "readonly": true,
      "required": false,
      "title": "Site Id",
      "type": "string"
    },
    "suffix": {
      "description": "User provided suffix string to resolve conflicting site entities.",
      "title": "Suffix string",
      "type": "string"
    }
  },
  "title": "Config onboarding Request",
  "type": "object"
}