templates

package
v4.0.3-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 18, 2023 License: UNKNOWN not legal advice Imports: 8 Imported by: 0

Documentation

Overview

Module vmm.v4.templates of Nutanix Vmm Versioned APIs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CompleteGuestUpdateSpec

type CompleteGuestUpdateSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  Indicates whether the version has to be a Gold version or not.
	*/
	SetActiveVersion *bool `json:"setActiveVersion,omitempty"`
	/*
	  A description for template version.
	*/
	VersionDescription *string `json:"versionDescription"`
	/*
	  Template version name. This will be the default VM name prefix when a VM is deployed from this template.
	*/
	VersionName *string `json:"versionName"`
}

Input to Template Complete Guest OS Update.

func NewCompleteGuestUpdateSpec

func NewCompleteGuestUpdateSpec() *CompleteGuestUpdateSpec

func (*CompleteGuestUpdateSpec) MarshalJSON

func (p *CompleteGuestUpdateSpec) MarshalJSON() ([]byte, error)

type GuestUpdateStatus

type GuestUpdateStatus struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  VM reference UUID.
	*/
	DeployedVmReference *string `json:"deployedVmReference,omitempty"`
}

VM reference for Template guest updates.

func NewGuestUpdateStatus

func NewGuestUpdateStatus() *GuestUpdateStatus

type InitiateGuestUpdateSpec

type InitiateGuestUpdateSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  Template Version number
	*/
	VersionNumber *int `json:"versionNumber,omitempty"`
}

Input to Template Guest OS update.

func NewInitiateGuestUpdateSpec

func NewInitiateGuestUpdateSpec() *InitiateGuestUpdateSpec

type OneOfTemplateApiResponseData

type OneOfTemplateApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplateApiResponseData

func NewOneOfTemplateApiResponseData() *OneOfTemplateApiResponseData

func (*OneOfTemplateApiResponseData) GetValue

func (p *OneOfTemplateApiResponseData) GetValue() interface{}

func (*OneOfTemplateApiResponseData) MarshalJSON

func (p *OneOfTemplateApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfTemplateApiResponseData) SetValue

func (p *OneOfTemplateApiResponseData) SetValue(v interface{}) error

func (*OneOfTemplateApiResponseData) UnmarshalJSON

func (p *OneOfTemplateApiResponseData) UnmarshalJSON(b []byte) error

type OneOfTemplateListApiResponseData

type OneOfTemplateListApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplateListApiResponseData

func NewOneOfTemplateListApiResponseData() *OneOfTemplateListApiResponseData

func (*OneOfTemplateListApiResponseData) GetValue

func (p *OneOfTemplateListApiResponseData) GetValue() interface{}

func (*OneOfTemplateListApiResponseData) MarshalJSON

func (p *OneOfTemplateListApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfTemplateListApiResponseData) SetValue

func (p *OneOfTemplateListApiResponseData) SetValue(v interface{}) error

func (*OneOfTemplateListApiResponseData) UnmarshalJSON

func (p *OneOfTemplateListApiResponseData) UnmarshalJSON(b []byte) error

type OneOfTemplateVersionApiResponseData

type OneOfTemplateVersionApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplateVersionApiResponseData

func NewOneOfTemplateVersionApiResponseData() *OneOfTemplateVersionApiResponseData

func (*OneOfTemplateVersionApiResponseData) GetValue

func (p *OneOfTemplateVersionApiResponseData) GetValue() interface{}

func (*OneOfTemplateVersionApiResponseData) MarshalJSON

func (p *OneOfTemplateVersionApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfTemplateVersionApiResponseData) SetValue

func (p *OneOfTemplateVersionApiResponseData) SetValue(v interface{}) error

func (*OneOfTemplateVersionApiResponseData) UnmarshalJSON

func (p *OneOfTemplateVersionApiResponseData) UnmarshalJSON(b []byte) error

type OneOfTemplateVersionListApiResponseData

type OneOfTemplateVersionListApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplateVersionListApiResponseData

func NewOneOfTemplateVersionListApiResponseData() *OneOfTemplateVersionListApiResponseData

func (*OneOfTemplateVersionListApiResponseData) GetValue

func (p *OneOfTemplateVersionListApiResponseData) GetValue() interface{}

func (*OneOfTemplateVersionListApiResponseData) MarshalJSON

func (p *OneOfTemplateVersionListApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfTemplateVersionListApiResponseData) SetValue

func (p *OneOfTemplateVersionListApiResponseData) SetValue(v interface{}) error

func (*OneOfTemplateVersionListApiResponseData) UnmarshalJSON

func (p *OneOfTemplateVersionListApiResponseData) UnmarshalJSON(b []byte) error

type OneOfTemplateVersionSpecVersionSource

type OneOfTemplateVersionSpecVersionSource struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplateVersionSpecVersionSource

func NewOneOfTemplateVersionSpecVersionSource() *OneOfTemplateVersionSpecVersionSource

func (*OneOfTemplateVersionSpecVersionSource) GetValue

func (p *OneOfTemplateVersionSpecVersionSource) GetValue() interface{}

func (*OneOfTemplateVersionSpecVersionSource) MarshalJSON

func (p *OneOfTemplateVersionSpecVersionSource) MarshalJSON() ([]byte, error)

func (*OneOfTemplateVersionSpecVersionSource) SetValue

func (p *OneOfTemplateVersionSpecVersionSource) SetValue(v interface{}) error

func (*OneOfTemplateVersionSpecVersionSource) UnmarshalJSON

func (p *OneOfTemplateVersionSpecVersionSource) UnmarshalJSON(b []byte) error

type OneOfTemplatesTaskApiResponseData

type OneOfTemplatesTaskApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTemplatesTaskApiResponseData

func NewOneOfTemplatesTaskApiResponseData() *OneOfTemplatesTaskApiResponseData

func (*OneOfTemplatesTaskApiResponseData) GetValue

func (p *OneOfTemplatesTaskApiResponseData) GetValue() interface{}

func (*OneOfTemplatesTaskApiResponseData) MarshalJSON

func (p *OneOfTemplatesTaskApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfTemplatesTaskApiResponseData) SetValue

func (p *OneOfTemplatesTaskApiResponseData) SetValue(v interface{}) error

func (*OneOfTemplatesTaskApiResponseData) UnmarshalJSON

func (p *OneOfTemplatesTaskApiResponseData) UnmarshalJSON(b []byte) error

type Template

type Template struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  The current gold version.
	*/
	ActiveVersionNumber *int `json:"activeVersionNumber,omitempty"`
	/*
	  Created Time.
	*/
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	/*
	  The user who created the Template.
	*/
	CreatedBy *string `json:"createdBy,omitempty"`
	/*
	  A globally unique identifier of an instance that is suitable for external consumption.
	*/
	ExtId *string `json:"extId,omitempty"`

	GuestUpdateStatus *GuestUpdateStatus `json:"guestUpdateStatus,omitempty"`
	/*
	  Last Update Time.
	*/
	LastUpdatedAt *time.Time `json:"lastUpdatedAt,omitempty"`
	/*
	  The user who updated the Version in Template.
	*/
	LastUpdatedBy *string `json:"lastUpdatedBy,omitempty"`
	/*
	  A HATEOAS style link for the response.  Each link contains a user friendly name identifying the link and an address for retrieving the particular resource.
	*/
	Links []import1.ApiLink `json:"links,omitempty"`
	/*
	  Indicates whether the version has to be a Gold version or not.
	*/
	SetActiveVersion *bool `json:"setActiveVersion,omitempty"`
	/*
	  A description for the Template.
	*/
	TemplateDescription *string `json:"templateDescription,omitempty"`
	/*
	  Template Name.
	*/
	TemplateName *string `json:"templateName,omitempty"`

	TemplateVersionSpec *TemplateVersionSpec `json:"templateVersionSpec,omitempty"`
	/*
	  A globally unique identifier that represents the tenant that owns this entity.  It is automatically assigned by the system and is immutable from an API consumer perspective (some use cases may cause this Id to change - for instance a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
	*/
	TenantId *string `json:"tenantId,omitempty"`
}

func NewTemplate

func NewTemplate() *Template

type TemplateApiResponse

type TemplateApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTemplateApiResponseData `json:"data,omitempty"`

	Metadata *import1.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /vmm/v4.0.a1/templates/{extId} Get operation

func NewTemplateApiResponse

func NewTemplateApiResponse() *TemplateApiResponse

func (*TemplateApiResponse) GetData

func (p *TemplateApiResponse) GetData() interface{}

func (*TemplateApiResponse) SetData

func (p *TemplateApiResponse) SetData(v interface{}) error

type TemplateDeployment

type TemplateDeployment struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  The UUID of the Cluster where the VM has to be deployed. This is mandatory to be specified for creating the VM.
	*/
	ClusterReference *string `json:"clusterReference"`
	/*
	  Number / Count of VMs to be deployed.
	*/
	NumberOfVms *int `json:"numberOfVms"`
	/*
	  The map containing keys as VM index and corresponding VM override config as values which is used at the time of deployment.
	*/
	OverrideVmConfigMap map[string]VmConfigOverride `json:"overrideVmConfigMap,omitempty"`
	/*
	  Template Version number
	*/
	VersionNumber *int `json:"versionNumber,omitempty"`
}

Deploy VM Config from the Template.

func NewTemplateDeployment

func NewTemplateDeployment() *TemplateDeployment

func (*TemplateDeployment) MarshalJSON

func (p *TemplateDeployment) MarshalJSON() ([]byte, error)

type TemplateListApiResponse

type TemplateListApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTemplateListApiResponseData `json:"data,omitempty"`

	Metadata *import1.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /vmm/v4.0.a1/templates Get operation

func NewTemplateListApiResponse

func NewTemplateListApiResponse() *TemplateListApiResponse

func (*TemplateListApiResponse) GetData

func (p *TemplateListApiResponse) GetData() interface{}

func (*TemplateListApiResponse) SetData

func (p *TemplateListApiResponse) SetData(v interface{}) error

type TemplatePublishSpec

type TemplatePublishSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  Template's active version which will be used as default for a VM deployment or a guest update
	*/
	ActiveVersionNumber *int `json:"activeVersionNumber"`
}

func NewTemplatePublishSpec

func NewTemplatePublishSpec() *TemplatePublishSpec

func (*TemplatePublishSpec) MarshalJSON

func (p *TemplatePublishSpec) MarshalJSON() ([]byte, error)

type TemplateVersionApiResponse

type TemplateVersionApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTemplateVersionApiResponseData `json:"data,omitempty"`

	Metadata *import1.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /vmm/v4.0.a1/templates/{extId}/versions/{versionNumber} Get operation

func NewTemplateVersionApiResponse

func NewTemplateVersionApiResponse() *TemplateVersionApiResponse

func (*TemplateVersionApiResponse) GetData

func (p *TemplateVersionApiResponse) GetData() interface{}

func (*TemplateVersionApiResponse) SetData

func (p *TemplateVersionApiResponse) SetData(v interface{}) error

type TemplateVersionListApiResponse

type TemplateVersionListApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTemplateVersionListApiResponseData `json:"data,omitempty"`

	Metadata *import1.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /vmm/v4.0.a1/templates/{extId}/versions Get operation

func NewTemplateVersionListApiResponse

func NewTemplateVersionListApiResponse() *TemplateVersionListApiResponse

func (*TemplateVersionListApiResponse) GetData

func (p *TemplateVersionListApiResponse) GetData() interface{}

func (*TemplateVersionListApiResponse) SetData

func (p *TemplateVersionListApiResponse) SetData(v interface{}) error

type TemplateVersionReference

type TemplateVersionReference struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`

	OverrideVmConfig *VmConfigOverride `json:"overrideVmConfig"`
	/*
	  Template Version number
	*/
	Version *int `json:"version"`
}

Template new version with Version Number and Override Config.

func NewTemplateVersionReference

func NewTemplateVersionReference() *TemplateVersionReference

func (*TemplateVersionReference) MarshalJSON

func (p *TemplateVersionReference) MarshalJSON() ([]byte, error)

type TemplateVersionSpec

type TemplateVersionSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  Created Time.
	*/
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	/*
	  The user who created the Version in Template.
	*/
	CreatedBy *string `json:"createdBy,omitempty"`
	/*
	  A globally unique identifier of an instance that is suitable for external consumption.
	*/
	ExtId *string `json:"extId,omitempty"`
	/*
	  Allow or Disallow override of the Guest Customization during Template Deployment using this version.
	*/
	IsGcOverrideEnabled *bool `json:"isGcOverrideEnabled,omitempty"`
	/*
	  A HATEOAS style link for the response.  Each link contains a user friendly name identifying the link and an address for retrieving the particular resource.
	*/
	Links []import1.ApiLink `json:"links,omitempty"`
	/*
	  A globally unique identifier that represents the tenant that owns this entity.  It is automatically assigned by the system and is immutable from an API consumer perspective (some use cases may cause this Id to change - for instance a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
	*/
	TenantId *string `json:"tenantId,omitempty"`
	/*
	  A description for template version.
	*/
	VersionDescription *string `json:"versionDescription,omitempty"`
	/*
	  Template version name. This will be the default VM name prefix when a VM is deployed from this template.
	*/
	VersionName *string `json:"versionName,omitempty"`
	/*
	  Template Version number
	*/
	VersionNumber *int `json:"versionNumber,omitempty"`

	VersionSourceItemDiscriminator_ *string `json:"$versionSourceItemDiscriminator,omitempty"`
	/*
	  Source from which a version is created. It can be either a VM or an existing version of the template.
	*/
	VersionSource *OneOfTemplateVersionSpecVersionSource `json:"versionSource,omitempty"`

	VersionSourceDiscriminator *string `json:"versionSourceDiscriminator,omitempty"`
	/*
	  VM configuration spec
	*/
	VmSpec *string `json:"vmSpec,omitempty"`
}

func NewTemplateVersionSpec

func NewTemplateVersionSpec() *TemplateVersionSpec

type TemplatesTaskApiResponse

type TemplatesTaskApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTemplatesTaskApiResponseData `json:"data,omitempty"`

	Metadata *import1.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /vmm/v4.0.a1/templates/{extId}/$actions/publish Post operation

func NewTemplatesTaskApiResponse

func NewTemplatesTaskApiResponse() *TemplatesTaskApiResponse

func (*TemplatesTaskApiResponse) GetData

func (p *TemplatesTaskApiResponse) GetData() interface{}

func (*TemplatesTaskApiResponse) SetData

func (p *TemplatesTaskApiResponse) SetData(v interface{}) error

type VmConfigOverride

type VmConfigOverride struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`

	GuestCustomization *import4.GuestCustomizationParams `json:"guestCustomization,omitempty"`
	/*
	  Memory size in bytes.
	*/
	MemorySizeBytes *int64 `json:"memorySizeBytes,omitempty"`
	/*
	  VM name.
	*/
	Name *string `json:"name,omitempty"`
	/*
	  NICs attached to the VM.
	*/
	Nics []import4.Nic `json:"nics,omitempty"`
	/*
	  Number of cores per socket.
	*/
	NumCoresPerSocket *int `json:"numCoresPerSocket,omitempty"`
	/*
	  Number of vCPU sockets.
	*/
	NumSockets *int `json:"numSockets,omitempty"`
	/*
	  Number of threads per core.
	*/
	NumThreadsPerCore *int `json:"numThreadsPerCore,omitempty"`
}

Overrides specification for VM create from a Template.

func NewVmConfigOverride

func NewVmConfigOverride() *VmConfigOverride

type VmReference

type VmReference struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  The source VM to create a new template
	*/
	ExtId *string `json:"extId"`
	/*
	  VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF Sysprep or CloudInit should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if 'isOverridable' is set to 'True' then the deployer can upload their own custom script.
	*/
	GuestCustomization *string `json:"guestCustomization,omitempty"`
}

The source VM to create a new template

func NewVmReference

func NewVmReference() *VmReference

func (*VmReference) MarshalJSON

func (p *VmReference) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL