This API has a deprecated equivalent from v7.0U1.

Create Library Item

Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item.

if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource null or null referenced by the attribute LibraryItem.DeployableIdentity.id requires VApp.Export. - The resource com.vmware.content.Library referenced by the attribute LibraryItem.CreateTarget.library-id requires ContentLibrary.AddLibraryItem. - The resource com.vmware.content.library.Item referenced by the attribute LibraryItem.CreateTarget.library-item-id requires System.Read.

Request

URL

POST

https://{api_host}/api/vcenter/ovf/library-item

Copy

Header Parameters

string

client_token Optional

Client-generated token used to retry a request if the client fails to get a response from the server. If the original request succeeded, the result of that request will be returned, otherwise the operation will be retried. If unset, the server will create a token.

string

vmware-api-session-id Required

Required session ID, acquired from Create Session API under CIS product

vmware-api-session-id example

"b00db39f948d13ea1e59b4d6fce56389"

Request Body

OvfLibraryItemCreateRequestBody of mimetype application/json Required

This is a request body class for an operation.

(The request body parameter is missing description)

Show optional properties

{
	"create_spec": {},
	"source": {
		"id": "string",
		"type": "string"
	},
	"target": {
		"library_id": "string"
	}
}

{
	"create_spec": {
		"description": "string",
		"flags": [
			"string"
		],
		"name": "string"
	},
	"source": {
		"id": "string",
		"type": "string"
	},
	"target": {
		"library_id": "string",
		"library_item_id": "string"
	}
}

OvfLibraryItemCreateSpec

create_spec Required

Information used to create the OVF package from the source virtual machine or virtual appliance.

OvfLibraryItemDeployableIdentity

source Required

Identifier of the virtual machine or virtual appliance to use as the source.

OvfLibraryItemCreateTarget

target Required

Specification of the target content library and library item.

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

201 Created returns OvfLibraryItemCreateResult of type application/json

Information about the success or failure of the operation, along with the details of the result or failure.

{
	"error": {
		"errors": [
			{
				"category": "VALIDATION",
				"error": {},
				"issues": [
					{
						"category": "VALUE_ILLEGAL",
						"column_number": 0,
						"file": "string",
						"line_number": 0,
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						}
					}
				],
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"name": "string",
				"value": "string"
			}
		],
		"information": [
			{
				"messages": [
					{
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					}
				]
			}
		],
		"warnings": [
			{
				"category": "VALIDATION",
				"error": {},
				"issues": [
					{
						"category": "VALUE_ILLEGAL",
						"column_number": 0,
						"file": "string",
						"line_number": 0,
						"message": {
							"args": [
								"string"
							],
							"default_message": "string",
							"id": "string",
							"localized": "string",
							"params": {
								"key": {
									"d": 0,
									"dt": "string",
									"format": "SHORT_DATE",
									"i": 0,
									"l": {
										"id": "string",
										"params": "StdLocalizationParam Object"
									},
									"precision": 0,
									"s": "string"
								}
							}
						}
					}
				],
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"name": "string",
				"value": "string"
			}
		]
	},
	"ovf_library_item_id": "string",
	"succeeded": false
}

boolean

succeeded Required

Whether the LibraryItem.create operation completed successfully.

OvfLibraryItemResultInfo

error Optional

Errors, warnings, and informational messages produced by the LibraryItem.create operation. If unset, no errors, warnings, or informational messages were reported by the LibraryItem.create operation.

string

ovf_library_item_id Optional

Identifier of the created or updated library item. If unset, the LibraryItem.create operation failed and LibraryItem.CreateResult.error will describe the error(s) that caused the failure. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.

Errors

Error

400

com.vmware.vapi.std.errors.invalid_argument : if createSpec contains invalid arguments. if source describes an unexpected resource type. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the operation cannot be performed because of the specified virtual machine or virtual appliance’s current state. For example, if the virtual machine configuration information is not available, or if the virtual appliance is running.

Error

404

com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual appliance specified by source does not exist. if the library or library item specified by target does not exist.

Error

500

com.vmware.vapi.std.errors.resource_inaccessible : if there was an error accessing a file from the source virtual machine or virtual appliance. | com.vmware.vapi.std.errors.resource_busy : if the specified virtual machine or virtual appliance is busy.

Error

default

‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.

Code Samples

PowerCLI Client SDK Example

Show example with all parameters

$OvfLibraryItemDeployableIdentity = Initialize-OvfLibraryItemDeployableIdentity -Type "MyType" -Id "MyId"

$OvfLibraryItemCreateTarget = Initialize-OvfLibraryItemCreateTarget -LibraryId "MyLibraryId"

$OvfLibraryItemCreateSpec = Initialize-OvfLibraryItemCreateSpec

$OvfLibraryItemCreateRequestBody = Initialize-OvfLibraryItemCreateRequestBody -Source $OvfLibraryItemDeployableIdentity -Target $OvfLibraryItemCreateTarget -CreateSpec $OvfLibraryItemCreateSpec

Invoke-CreateOvfLibraryItem -OvfLibraryItemCreateRequestBody $OvfLibraryItemCreateRequestBody

PowerCLI Client SDK All Parameters Example

$OvfLibraryItemDeployableIdentity = Initialize-OvfLibraryItemDeployableIdentity -Type "MyType" -Id "MyId"

$OvfLibraryItemCreateTarget = Initialize-OvfLibraryItemCreateTarget -LibraryId "MyLibraryId" -LibraryItemId "MyLibraryItemId"

$OvfLibraryItemCreateSpec = Initialize-OvfLibraryItemCreateSpec -Name "MyName" -Description "MyDescription" -Flags "MyFlags"

$OvfLibraryItemCreateRequestBody = Initialize-OvfLibraryItemCreateRequestBody -Source $OvfLibraryItemDeployableIdentity -Target $OvfLibraryItemCreateTarget -CreateSpec $OvfLibraryItemCreateSpec

Invoke-CreateOvfLibraryItem -OvfLibraryItemCreateRequestBody $OvfLibraryItemCreateRequestBody -ClientToken "MyClientToken"

cURL Command

curl -X POST -H "client_token: string" -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"create_spec":{"description":"string","flags":["string"],"name":"string"},"source":{"id":"string","type":"string"},"target":{"library_id":"string","library_item_id":"string"}}' https://{api_host}/api/vcenter/ovf/library-item

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/vcenter/ovf/library-item
x-vmw-doc-operation: create

Availability

Added in 7.0U2

Library Item Operations

post

Create Library Item

post

Deploy Library Item

post

Filter Library Item

Create Library Item

On This Page

Request

URL

Header Parameters

vmware-api-session-id example

Request Body

Authentication

api_key

Response

Response Body

Errors

Code Samples

PowerCLI Client SDK Example

PowerCLI Client SDK All Parameters Example

cURL Command

Vendor Extensions

Availability

On This Page

Library Item Operations

Was this page helpful?