REST API - get

vcenter ovf import session: get

Retrieves information about an import session.

Request:

HTTP request

GET https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}

Path Parameters

Name Type Description
Required
id string the import session ID.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "file_transfer_mode""SERVER_TRANSFER_MODE",
        "vm_id""obj-103",
        "warnings"[
            {
                "name""string",
                "category""VALIDATION",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                "error"{
                    "@class""com.vmware.vapi.std.errors.error",
                    "data"{
                        "@class""dynamic_structure"
                    },
                    "error_type""ERROR",
                    "messages"[
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        },
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    ]
                },
                "issues"[
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    }
                ],
                "value""string"
            },
            {
                "name""string",
                "category""VALIDATION",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                "error"{
                    "@class""com.vmware.vapi.std.errors.error",
                    "data"{
                        "@class""dynamic_structure"
                    },
                    "error_type""ERROR",
                    "messages"[
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        },
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    ]
                },
                "issues"[
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    }
                ],
                "value""string"
            }
        ],
        "customization_results"[
            {
                "value"true,
                "key""string"
            }
        ],
        "progress"1,
        "files"[
            {
                "optional_upload"true,
                "ssl_thumb_print""string",
                "bytes_transferred"1,
                "file_url""http://myurl.com",
                "size"1,
                "sha256""string",
                "file_type""OVF",
                "name""string",
                "upload_method""PUT"
            },
            {
                "optional_upload"true,
                "ssl_thumb_print""string",
                "bytes_transferred"1,
                "file_url""http://myurl.com",
                "size"1,
                "sha256""string",
                "file_type""OVF",
                "name""string",
                "upload_method""PUT"
            }
        ],
        "information"[
            {
                "messages"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                ]
            },
            {
                "messages"[
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    },
                    {
                        "args"[
                            "string",
                            "string"
                        ],
                        "default_message""string",
                        "localized""string",
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "value"{
                                                    "dt""2015-01-01T22:13:05.651Z",
                                                    "s""string",
                                                    "d"1.5,
                                                    "precision"1,
                                                    "format""SHORT_DATE",
                                                    "i"1,
                                                    "l"{
                                                        "id""string",
                                                        "params"[
                                                            {
                                                                "key""string"
                                                            }
                                                        ]
                                                    }
                                                },
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                ]
            }
        ],
        "state""IMPORT_OVF_TRANSFER",
        "vapp_id""obj-103",
        "errors"[
            {
                "name""string",
                "category""VALIDATION",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                "error"{
                    "@class""com.vmware.vapi.std.errors.error",
                    "data"{
                        "@class""dynamic_structure"
                    },
                    "error_type""ERROR",
                    "messages"[
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        },
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    ]
                },
                "issues"[
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    }
                ],
                "value""string"
            },
            {
                "name""string",
                "category""VALIDATION",
                "message"{
                    "args"[
                        "string",
                        "string"
                    ],
                    "default_message""string",
                    "localized""string",
                    "id""string",
                    "params"[
                        {
                            "value"{
                                "dt""2015-01-01T22:13:05.651Z",
                                "s""string",
                                "d"1.5,
                                "precision"1,
                                "format""SHORT_DATE",
                                "i"1,
                                "l"{
                                    "id""string",
                                    "params"[
                                        {
                                            "value"{
                                                "dt""2015-01-01T22:13:05.651Z",
                                                "s""string",
                                                "d"1.5,
                                                "precision"1,
                                                "format""SHORT_DATE",
                                                "i"1,
                                                "l"{
                                                    "id""string",
                                                    "params"[
                                                        {
                                                            "key""string"
                                                        }
                                                    ]
                                                }
                                            },
                                            "key""string"
                                        }
                                    ]
                                }
                            },
                            "key""string"
                        }
                    ]
                },
                "error"{
                    "@class""com.vmware.vapi.std.errors.error",
                    "data"{
                        "@class""dynamic_structure"
                    },
                    "error_type""ERROR",
                    "messages"[
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        },
                        {
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    ]
                },
                "issues"[
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    },
                    {
                        "file""string",
                        "line_number"1,
                        "column_number"1,
                        "category""VALUE_ILLEGAL",
                        "message"{
                            "args"[
                                "string",
                                "string"
                            ],
                            "default_message""string",
                            "localized""string",
                            "id""string",
                            "params"[
                                {
                                    "value"{
                                        "dt""2015-01-01T22:13:05.651Z",
                                        "s""string",
                                        "d"1.5,
                                        "precision"1,
                                        "format""SHORT_DATE",
                                        "i"1,
                                        "l"{
                                            "id""string",
                                            "params"[
                                                {
                                                    "value"{
                                                        "dt""2015-01-01T22:13:05.651Z",
                                                        "s""string",
                                                        "d"1.5,
                                                        "precision"1,
                                                        "format""SHORT_DATE",
                                                        "i"1,
                                                        "l"{
                                                            "id""string",
                                                            "params"[
                                                                {
                                                                    "key""string"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    "key""string"
                                                }
                                            ]
                                        }
                                    },
                                    "key""string"
                                }
                            ]
                        }
                    }
                ],
                "value""string"
            }
        ]
    }
}

Response Type:

Name Type Description
bold = required
value info Returns information about an import session.
value.state string The state for the current transfer.

Defines the different states of a transfer.

For pull imports files are pulled by the server using HTTP GET, for push imports the client uses HTTP PUT to upload the data. For a content library import, the server retrieves the files from the content library.

The transition diagram is as follows for a pull or content library import:

  • IMPORT_OVF_TRANSFER: Initial state, where server is retrieving OVF descriptor, message bundles, certificates, and manifests.
  • IMPORT_SELECTING_OVF_PARAMS: Waiting for user to call Instantiate to begin the instantiation.
  • IMPORT_FILE_TRANSFER: Transfering files from the source.
  • IMPORT_INSTANTIATING: Instantiating the virtual machines/virtual appliance.
  • IMPORT_COMPLETED: Import completed successfully.

The transition diagram is as follows for a push import:

  • IMPORT_OVF_TRANSFER: Initial state where server is waiting for the OVF descriptor to be uploaded.
  • IMPORT_MSG_BUNDLES_TRANSFER: Server is waiting for message bundles to be uploaded.
  • IMPORT_SELECTING_OVF_PARAMS: Waiting for user to begin the instantiation.
  • IMPORT_FILE_TRANSFER: Server is waiting for all files to be uploaded.
  • IMPORT_INSTANTIATING: Instantiating the virtual machines/virtual appliance.
  • IMPORT_COMPLETED: Import completed successfully.

The client is allowed to upload files as soon as the appear in the import session object. Thus upload can begin before reaching the IMPORT_FILE_TRANSFER state.

Value is one of:
IMPORT_OVF_TRANSFER: State of an import transfer that does not have any files available. The transfer needs the OVF descriptor to continue. If this is a push transfer, the client must upload the OVF descriptor, and the transfer file list has one file info entry with a URL to which the client must upload the OVF descriptor using HTTP PUT. For pull transfers (including content library), the server is in the process of retrieving the OVF descriptor.

Transition to the next state is done when the server has retrieved the complete OVF content and parsed it.


IMPORT_MSG_BUNDLES_TRANSFER: The file list contains a number of message bundles that need to be transferred to the server. If this is a push transfer, the client must PUT the requested files to the server.

In case the OVF descriptor does not specify any bundles this state is skipped.

Transition to next state is done when the complete content of all message bundles has been retrieved by the server.


IMPORT_SELECTING_OVF_PARAMS: The server can be queried for OVF parameters, and the client can specify instantiation parameters.

Specifying an OVF instantiation parameter might affect other OVF instantiation parameters and change the set of files that needs to get transferred.

During this state the client is allowed to push other files to the server with HTTP PUT.

Transition to the next state is done by calling the instantiate method. If all needed files have been transferred to the server a transition is made to IMPORT_INSTANTIATING, otherwise a transition is made to IMPORT_FILE_TRANSFER.


IMPORT_FILE_TRANSFER: State for transferring remaining files that have not been transferred during an earlier state.

When the content of all files has been transferred the state is changed to IMPORT_INSTANTIATING:

  • Pull transfer: All needed files have been completely transferred, and the manifest and certificate have been transferred if they are available.
  • Push transfer: All files marked as required (attribute optional == false) have been transferred and all initiated transfers of optional files are complete. In particular the manifest and certificate are optional so the upload of these has to at least be initiated before other files are completely uploaded.

    IMPORT_INSTANTIATING: The virtual machine or virtual appliance is being instantiated.
    IMPORT_COMPLETED: The virtual machine or virtual appliance is instantiated, and the upload transfer is done.
    IMPORT_ERROR: The transfer failed.
    value.progress long Progress of import.

    value.file_transfer_mode string The transfer mode for disk files.

    It is unset initially until state IMPORT_FILE_TRANSFER is reached.

    Optional. It is only relevant when state has value [IMPORT_FILE_TRANSFER, IMPORT_INSTANTIATING, IMPORT_COMPLETED, IMPORT_ERROR]. It is unset initially.

    value.files ovf_file_info[] Array of files that are part of this transfer.

    There is an entry for the OVF descriptor, files defined in the file reference section of the OVF descriptor, and optional manifest and certificate.

    The entries are not fixed during the lifetime of the import. It can change when instantiation parameters are selected. It is fixed from state IMPORT_FILE_TRANSFER and onwards.

    value.files[].name string Name of the file.

    For files in the file reference section of the OVF this is the name defined in that section. For OVF descriptor, manifest or certificate files the server will assign a name.

    If vcenter.ovf.ovf_file_info.file_type is OVA, this is will be an assigned name indicating the content that will be transferred from the OVA package file. For example, descriptor.ova refers to the OVF descriptor in the OVA file, message-bundle.ova refers to the message bundle files in the OVA file, disk-content.ova refers to all the disk content in the OVA file.

    value.files[].file_type string The type of file.

    Indicates files that have special semantics in an OVF package, or indicates an OVA package file. Value is one of:
    OVF: The file is an OVF descriptor.
    MANIFEST: The file is a manifest.
    CERT: The file is a certificate.
    MSG_BUNDLE: A file with localized messages for the OVF.
    DISK: The file is a disk.
    CONTENT: Anything else a file that does not need special treatment during transfer.
    OVA: The file is an OVA file.
    NVRAM: The file is a NVRAM file for EFI boot support.

    value.files[].optional_upload boolean Indicates whether the file has to be supplied by the client. If this is a PUSH import, this field will be false if the client must upload the file to the URL specified in vcenter.ovf.ovf_file_info.file_url, and true if the client is not required to upload the file. If this is a PULL import or export, this field can be ignored.

    value.files[].file_url URI The location of the file.

    When the OVF package is being imported by the client pushing files to the server (see Import#SourceType#PUSH_SOURCE) this is the URL that the client must upload to. If ImportSession#externalTransferSupported is true, the URL may be from external service. When the OVF package is being imported by the server pulling files (see {@link Import #SourceType#PULL_SOURCE}) this is the URL that the server will download from.

    When this is an OVF package export, then it is the URL that the client is downloading from. For certain file types, such as FileType.MANIFEST, this URL will be unset until the file is ready for download.

    Optional.

    value.files[].ssl_thumb_print string The SSL thumb print that is for the {@link OvfFileInfo #fileUrl} if required by it.

    Optional.

    value.errors ovf_error[] Array of errors. Errors will prevent the import from proceeding.

    value.errors[].error.messages localizable_message[] Stack of one or more localizable messages for human error consumers.

    The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

    value.errors[].error.data object Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

    Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The vapi.std.errors.argument_locations, vapi.std.errors.file_locations, and vapi.std.errors.transient_indication structures are intended as possible values for this field. vapi.std.dynamic_ID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

    Optional. Some operations will not set this field when reporting errors.

    value.errors[].error.error_type string Discriminator field to help API consumers identify the structure type. This attribute was added in vSphere API 6.7.2.

    Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST. This enumeration was added in vSphere API 6.7.2. Value is one of:
    ERROR: Discriminator for the vapi.std.errors.error type. This constant was added in vSphere API 6.7.2.
    ALREADY_EXISTS: Discriminator for the vapi.std.errors.already_exists type. This constant was added in vSphere API 6.7.2.
    ALREADY_IN_DESIRED_STATE: Discriminator for the vapi.std.errors.already_in_desired_state type. This constant was added in vSphere API 6.7.2.
    CANCELED: Discriminator for the vapi.std.errors.canceled type. This constant was added in vSphere API 6.7.2.
    CONCURRENT_CHANGE: Discriminator for the vapi.std.errors.concurrent_change type. This constant was added in vSphere API 6.7.2.
    FEATURE_IN_USE: Discriminator for the vapi.std.errors.feature_in_use type. This constant was added in vSphere API 6.7.2.
    INTERNAL_SERVER_ERROR: Discriminator for the vapi.std.errors.internal_server_error type. This constant was added in vSphere API 6.7.2.
    INVALID_ARGUMENT: Discriminator for the vapi.std.errors.invalid_argument type. This constant was added in vSphere API 6.7.2.
    INVALID_ELEMENT_CONFIGURATION: Discriminator for the vapi.std.errors.invalid_element_configuration type. This constant was added in vSphere API 6.7.2.
    INVALID_ELEMENT_TYPE: Discriminator for the vapi.std.errors.invalid_element_type type. This constant was added in vSphere API 6.7.2.
    INVALID_REQUEST: Discriminator for the vapi.std.errors.invalid_request type. This constant was added in vSphere API 6.7.2.
    NOT_ALLOWED_IN_CURRENT_STATE: Discriminator for the vapi.std.errors.not_allowed_in_current_state type. This constant was added in vSphere API 6.7.2.
    NOT_FOUND: Discriminator for the vapi.std.errors.not_found type. This constant was added in vSphere API 6.7.2.
    OPERATION_NOT_FOUND: Discriminator for the vapi.std.errors.operation_not_found type. This constant was added in vSphere API 6.7.2.
    RESOURCE_BUSY: Discriminator for the vapi.std.errors.resource_busy type. This constant was added in vSphere API 6.7.2.
    RESOURCE_IN_USE: Discriminator for the vapi.std.errors.resource_in_use type. This constant was added in vSphere API 6.7.2.
    RESOURCE_INACCESSIBLE: Discriminator for the vapi.std.errors.resource_inaccessible type. This constant was added in vSphere API 6.7.2.
    SERVICE_UNAVAILABLE: Discriminator for the vapi.std.errors.service_unavailable type. This constant was added in vSphere API 6.7.2.
    TIMED_OUT: Discriminator for the vapi.std.errors.timed_out type. This constant was added in vSphere API 6.7.2.
    UNABLE_TO_ALLOCATE_RESOURCE: Discriminator for the vapi.std.errors.unable_to_allocate_resource type. This constant was added in vSphere API 6.7.2.
    UNAUTHENTICATED: Discriminator for the vapi.std.errors.unauthenticated type. This constant was added in vSphere API 6.7.2.
    UNAUTHORIZED: Discriminator for the vapi.std.errors.unauthorized type. This constant was added in vSphere API 6.7.2.
    UNEXPECTED_INPUT: Discriminator for the vapi.std.errors.unexpected_input type. This constant was added in vSphere API 6.7.2.
    UNSUPPORTED: Discriminator for the vapi.std.errors.unsupported type. This constant was added in vSphere API 6.7.2.
    UNVERIFIED_PEER: Discriminator for the vapi.std.errors.unverified_peer type. This constant was added in vSphere API 6.7.2.Optional. Can be unset for compatibility with preceding implementations.

    value.warnings ovf_warning[] Array of warnings. Warnings will not prevent the import from proceeding, but there might be issues that warrant attention.

    value.warnings[].error.messages localizable_message[] Stack of one or more localizable messages for human error consumers.

    The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

    value.warnings[].error.data object Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

    Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The vapi.std.errors.argument_locations, vapi.std.errors.file_locations, and vapi.std.errors.transient_indication structures are intended as possible values for this field. vapi.std.dynamic_ID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

    Optional. Some operations will not set this field when reporting errors.

    value.warnings[].error.error_type string Discriminator field to help API consumers identify the structure type. This attribute was added in vSphere API 6.7.2.

    Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST. This enumeration was added in vSphere API 6.7.2. Value is one of:
    ERROR: Discriminator for the vapi.std.errors.error type. This constant was added in vSphere API 6.7.2.
    ALREADY_EXISTS: Discriminator for the vapi.std.errors.already_exists type. This constant was added in vSphere API 6.7.2.
    ALREADY_IN_DESIRED_STATE: Discriminator for the vapi.std.errors.already_in_desired_state type. This constant was added in vSphere API 6.7.2.
    CANCELED: Discriminator for the vapi.std.errors.canceled type. This constant was added in vSphere API 6.7.2.
    CONCURRENT_CHANGE: Discriminator for the vapi.std.errors.concurrent_change type. This constant was added in vSphere API 6.7.2.
    FEATURE_IN_USE: Discriminator for the vapi.std.errors.feature_in_use type. This constant was added in vSphere API 6.7.2.
    INTERNAL_SERVER_ERROR: Discriminator for the vapi.std.errors.internal_server_error type. This constant was added in vSphere API 6.7.2.
    INVALID_ARGUMENT: Discriminator for the vapi.std.errors.invalid_argument type. This constant was added in vSphere API 6.7.2.
    INVALID_ELEMENT_CONFIGURATION: Discriminator for the vapi.std.errors.invalid_element_configuration type. This constant was added in vSphere API 6.7.2.
    INVALID_ELEMENT_TYPE: Discriminator for the vapi.std.errors.invalid_element_type type. This constant was added in vSphere API 6.7.2.
    INVALID_REQUEST: Discriminator for the vapi.std.errors.invalid_request type. This constant was added in vSphere API 6.7.2.
    NOT_ALLOWED_IN_CURRENT_STATE: Discriminator for the vapi.std.errors.not_allowed_in_current_state type. This constant was added in vSphere API 6.7.2.
    NOT_FOUND: Discriminator for the vapi.std.errors.not_found type. This constant was added in vSphere API 6.7.2.
    OPERATION_NOT_FOUND: Discriminator for the vapi.std.errors.operation_not_found type. This constant was added in vSphere API 6.7.2.
    RESOURCE_BUSY: Discriminator for the vapi.std.errors.resource_busy type. This constant was added in vSphere API 6.7.2.
    RESOURCE_IN_USE: Discriminator for the vapi.std.errors.resource_in_use type. This constant was added in vSphere API 6.7.2.
    RESOURCE_INACCESSIBLE: Discriminator for the vapi.std.errors.resource_inaccessible type. This constant was added in vSphere API 6.7.2.
    SERVICE_UNAVAILABLE: Discriminator for the vapi.std.errors.service_unavailable type. This constant was added in vSphere API 6.7.2.
    TIMED_OUT: Discriminator for the vapi.std.errors.timed_out type. This constant was added in vSphere API 6.7.2.
    UNABLE_TO_ALLOCATE_RESOURCE: Discriminator for the vapi.std.errors.unable_to_allocate_resource type. This constant was added in vSphere API 6.7.2.
    UNAUTHENTICATED: Discriminator for the vapi.std.errors.unauthenticated type. This constant was added in vSphere API 6.7.2.
    UNAUTHORIZED: Discriminator for the vapi.std.errors.unauthorized type. This constant was added in vSphere API 6.7.2.
    UNEXPECTED_INPUT: Discriminator for the vapi.std.errors.unexpected_input type. This constant was added in vSphere API 6.7.2.
    UNSUPPORTED: Discriminator for the vapi.std.errors.unsupported type. This constant was added in vSphere API 6.7.2.
    UNVERIFIED_PEER: Discriminator for the vapi.std.errors.unverified_peer type. This constant was added in vSphere API 6.7.2.Optional. Can be unset for compatibility with preceding implementations.

    value.information ovf_info[] Array of information. A typical case is that a non-required element will be skipped for some reason.

    value.vapp_id string The identifier of the virtual appliance imported in case the OVF was a virtual appliance. This is not set until the virtual appliance is created. Only one of vcenter.ovf.import_session.info.vapp_id and vcenter.ovf.import_session.info.vm_id will be set.

    Optional. Only one of vcenter.ovf.import_session.info.vapp_id and vcenter.ovf.import_session.info.vm_id will be set.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualApp. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualApp.

    value.vm_id string The identifier of the virtual machine imported in case the OVF was a virtual machine. This is not set until a virtual machine is created. Only one of vcenter.ovf.import_session.info.vapp_id and vcenter.ovf.import_session.info.vm_id will be set.

    Optional. Only one of vcenter.ovf.import_session.info.vapp_id and vcenter.ovf.import_session.info.vm_id will be set.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

    value.customization_results list Results of all the customizations applied to deployed resource entity or sub-entities as part of the instantiate operation. The key in the key/value pairs is the identifier of the resource entity and the value is the success indicator of the application of the customization to the resource entity.

    Optional. Guest OS customization need not be specified for deployment.

    Errors:

    HTTP Status Code Type Description
    404 not_found if the specified session could not be found. It may have been deleted or timed out.