REST API - vcenter_guest_customization

vcenter ovf: vcenter guest customization params

The vcenter_guest_customization_params structure contains the parameters with information about customization of ovf:VirtualSystem using vCenter guest OS customization specifications.

Representation:

JSON
LEGACY JSON

{
    "type" : "string",
    "virtual_systems" : [
        "string",
        "string"
    ],
    "customizations" : {
        "<string>" : {
            "specification_id" : "string",
            "xml" : "string",
            "type" : "SPECIFICATION"
        }
    }
}

{
    "type" : "string",
    "virtual_systems" : [
        "string",
        "string"
    ],
    "customizations" : [
        {
            "value" : {
                "specification_id" : "string",
                "xml" : "string",
                "type" : "SPECIFICATION"
            },
            "key" : "string"
        }
    ]
}

Attributes:

Name	Type	Description
Required
-.customizations.*	vcenter_guest_customization
-.customizations.*.type	string	Type of customization scheme to use in order to customize the target virtual machine. Defines the supported types of guest customization schemes for sections of type ovf:VirtualSystem in the OVF descriptor. Value is one of: SPECIFICATION: Customization setting is encapsulated in a vCenter Server guest operating system customization specification. XML: Customization setting is encapsulated in an XML document- formatted string. The content of the string describes a vCenter server guest operating system customization specification.
Optional
-.virtual_systems	string[]	List of section identifiers of ovf:VirtualSystem sections in the OVF descriptor. Optional. This field is not used in the input parameters when deploying an OVF package.
-.customizations	object	Specification of the target guest OS customization to use for sections of type ovf:VirtualSystem in the OVF descriptor. The key in the key/value pairs is the section identifier of the ovf:VirtualSystem section in the OVF descriptor and the value is the guest OS customization specification to be used for deployment. See vcenter.ovf.vcenter_guest_customization. Optional. If unset, no guest customization will be applied.
-.customizations.*.specification_id	string	Target guest OS customization specification to use to customize the virtual machine. The value of this field specifies the ID of the specification item stored in vCenter's customization specification manager. Optional. It is only relevant when type has value SPECIFICATION. This field is optional and it is only relevant when the value of `type` is SPECIFICATION.
-.customizations.*.xml	string	Target guest OS customization specification to use to customize the virtual machine. The value of this field contains the XML document content to be interpreted by vCenter's customization specification manager as a vCenter guest customization specification. Optional. It is only relevant when type has value XML. This field is optional and it is only relevant when the value of `type` is XML.
-.type	string	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Attributes:

Name	Type	Description
Required
customizations[].key	string
customizations[].value	vcenter_guest_customization
customizations[].value.type	string	Type of customization scheme to use in order to customize the target virtual machine. Defines the supported types of guest customization schemes for sections of type ovf:VirtualSystem in the OVF descriptor. Value is one of: SPECIFICATION: Customization setting is encapsulated in a vCenter Server guest operating system customization specification. XML: Customization setting is encapsulated in an XML document- formatted string. The content of the string describes a vCenter server guest operating system customization specification.
Optional
virtual_systems	string[]	List of section identifiers of ovf:VirtualSystem sections in the OVF descriptor. Optional. This field is not used in the input parameters when deploying an OVF package.
customizations	list	Specification of the target guest OS customization to use for sections of type ovf:VirtualSystem in the OVF descriptor. The key in the key/value pairs is the section identifier of the ovf:VirtualSystem section in the OVF descriptor and the value is the guest OS customization specification to be used for deployment. See vcenter.ovf.vcenter_guest_customization. Optional. If unset, no guest customization will be applied.
customizations[].value.specification_id	string	Target guest OS customization specification to use to customize the virtual machine. The value of this field specifies the ID of the specification item stored in vCenter's customization specification manager. Optional. It is only relevant when type has value SPECIFICATION. This field is optional and it is only relevant when the value of `type` is SPECIFICATION.
customizations[].value.xml	string	Target guest OS customization specification to use to customize the virtual machine. The value of this field contains the XML document content to be interpreted by vCenter's customization specification manager as a vCenter guest customization specification. Optional. It is only relevant when type has value XML. This field is optional and it is only relevant when the value of `type` is XML.
type	string	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.