terraform/vendor/github.com/ukcloud/govcloudair/types/v56/types.go

1704 lines
100 KiB
Go

/*
* Copyright 2014 VMware, Inc. All rights reserved. Licensed under the Apache v2 License.
*/
package types
import (
"encoding/xml"
)
// Maps status Attribute Values for VAppTemplate, VApp, Vm, and Media Objects
var VAppStatuses = map[int]string{
-1: "FAILED_CREATION",
0: "UNRESOLVED",
1: "RESOLVED",
2: "DEPLOYED",
3: "SUSPENDED",
4: "POWERED_ON",
5: "WAITING_FOR_INPUT",
6: "UNKNOWN",
7: "UNRECOGNIZED",
8: "POWERED_OFF",
9: "INCONSISTENT_STATE",
10: "MIXED",
11: "DESCRIPTOR_PENDING",
12: "COPYING_CONTENTS",
13: "DISK_CONTENTS_PENDING",
14: "QUARANTINED",
15: "QUARANTINE_EXPIRED",
16: "REJECTED",
17: "TRANSFER_TIMEOUT",
18: "VAPP_UNDEPLOYED",
19: "VAPP_PARTIALLY_DEPLOYED",
}
// Maps status Attribute Values for VDC Objects
var VDCStatuses = map[int]string{
-1: "FAILED_CREATION",
0: "NOT_READY",
1: "READY",
2: "UNKNOWN",
3: "UNRECOGNIZED",
}
// VCD API
// DefaultStorageProfileSection is the name of the storage profile that will be specified for this virtual machine. The named storage profile must exist in the organization vDC that contains the virtual machine. If not specified, the default storage profile for the vDC is used.
// Type: DefaultStorageProfileSection_Type
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Name of the storage profile that will be specified for this virtual machine. The named storage profile must exist in the organization vDC that contains the virtual machine. If not specified, the default storage profile for the vDC is used.
// Since: 5.1
type DefaultStorageProfileSection struct {
StorageProfile string `xml:"StorageProfile,omitempty"`
}
// CustomizationSection represents a vApp template customization settings.
// Type: CustomizationSectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a vApp template customization settings.
// Since: 1.0
type CustomizationSection struct {
// FIXME: OVF Section needs to be laid down correctly
Info string `xml:"ovf:Info"`
//
GoldMaster bool `xml:"goldMaster,attr,omitempty"`
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
CustomizeOnInstantiate bool `xml:"CustomizeOnInstantiate"`
Link LinkList `xml:"Link,omitempty"`
}
// LeaseSettingsSection represents vApp lease settings.
// Type: LeaseSettingsSectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents vApp lease settings.
// Since: 0.9
type LeaseSettingsSection struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
DeploymentLeaseExpiration string `xml:"DeploymentLeaseExpiration,omitempty"`
DeploymentLeaseInSeconds int `xml:"DeploymentLeaseInSeconds,omitempty"`
Link *Link `xml:"Link,omitempty"`
StorageLeaseExpiration string `xml:"StorageLeaseExpiration,omitempty"`
StorageLeaseInSeconds int `xml:"StorageLeaseInSeconds,omitempty"`
}
// IPRange represents a range of IP addresses, start and end inclusive.
// Type: IpRangeType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a range of IP addresses, start and end inclusive.
// Since: 0.9
type IPRange struct {
StartAddress string `xml:"StartAddress"` // Start address of the IP range.
EndAddress string `xml:"EndAddress"` // End address of the IP range.
}
// DhcpService represents a DHCP network service.
// Type: DhcpServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a DHCP network service.
// Since:
type DhcpService struct {
DefaultLeaseTime int `xml:"DefaultLeaseTime,omitempty"` // Default lease in seconds for DHCP addresses.
DomainName string `xml:"DomainName,omitempty"` // The domain name.
IPRange *IPRange `xml:"IpRange"` // IP range for DHCP addresses.
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
MaxLeaseTime int `xml:"MaxLeaseTime"` // Max lease in seconds for DHCP addresses.
PrimaryNameServer string `xml:"PrimaryNameServer,omitempty"` // The primary name server.
RouterIP string `xml:"RouterIp,omitempty"` // Router IP.
SecondaryNameServer string `xml:"SecondaryNameServer,omitempty"` // The secondary name server.
SubMask string `xml:"SubMask,omitempty"` // The subnet mask.
}
// NetworkFeatures represents features of a network.
// Type: NetworkFeaturesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents features of a network.
// Since:
type NetworkFeatures struct {
DhcpService *DhcpService `xml:"DhcpService,omitempty"` // Substitute for NetworkService. DHCP service settings
FirewallService *FirewallService `xml:"FirewallService,omitempty"` // Substitute for NetworkService. Firewall service settings
NatService *NatService `xml:"NatService,omitempty"` // Substitute for NetworkService. NAT service settings
LoadBalancerService *LoadBalancerService `xml:"LoadBalancerService,omitempty"` // Substitute for NetworkService. Load Balancer service settings
StaticRoutingService *StaticRoutingService `xml:"StaticRoutingService,omitempty"` // Substitute for NetworkService. Static Routing service settings
// TODO: Not Implemented
// IpsecVpnService IpsecVpnService `xml:"IpsecVpnService,omitempty"` // Substitute for NetworkService. Ipsec Vpn service settings
}
// IPAddresses a list of IP addresses
// Type: IpAddressesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A list of IP addresses.
// Since: 0.9
type IPAddresses struct {
IPAddress string `xml:"IpAddress,omitempty"` // An IP address.
}
// IPRanges representsa list of IP ranges.
// Type: IpRangesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a list of IP ranges.
// Since: 0.9
type IPRanges struct {
IPRange []*IPRange `xml:"IpRange,omitempty"` // IP range.
}
// IPScope specifies network settings like gateway, network mask, DNS servers IP ranges etc
// Type: IpScopeType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Specify network settings like gateway, network mask, DNS servers, IP ranges, etc.
// Since: 0.9
type IPScope struct {
IsInherited bool `xml:"IsInherited"` // True if the IP scope is inherit from parent network.
Gateway string `xml:"Gateway,omitempty"` // Gateway of the network.
Netmask string `xml:"Netmask,omitempty"` // Network mask.
DNS1 string `xml:"Dns1,omitempty"` // Primary DNS server.
DNS2 string `xml:"Dns2,omitempty"` // Secondary DNS server.
DNSSuffix string `xml:"DnsSuffix,omitempty"` // DNS suffix.
IsEnabled bool `xml:"IsEnabled"` // Indicates if subnet is enabled or not. Default value is True.
IPRanges *IPRanges `xml:"IpRanges,omitempty"` // IP ranges used for static pool allocation in the network.
AllocatedIPAddresses *IPAddresses `xml:"AllocatedIpAddresses,omitempty"` // Read-only list of allocated IP addresses in the network.
SubAllocations *SubAllocations `xml:"SubAllocations,omitempty"` // Read-only list of IP addresses that are sub allocated to edge gateways.
}
// SubAllocations a list of IP addresses that are sub allocated to edge gateways.
// Type: SubAllocationsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A list of IP addresses that are sub allocated to edge gateways.
// Since: 5.1
type SubAllocations struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
// Elements
Link LinkList `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
SubAllocation *SubAllocation `xml:"SubAllocation,omitempty"` // IP Range sub allocated to a edge gateway.
}
// SubAllocation IP range sub allocated to an edge gateway.
// Type: SubAllocationType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: IP range sub allocated to an edge gateway.
// Since: 5.1
type SubAllocation struct {
EdgeGateway *Reference `xml:"EdgeGateway,omitempty"` // Edge gateway that uses this sub allocation.
IPRanges *IPRanges `xml:"IpRanges,omitempty"` // IP range sub allocated to the edge gateway.
}
// IPScopes represents a list of IP scopes.
// Type: IpScopesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a list of IP scopes.
// Since: 5.1
type IPScopes struct {
IPScope IPScope `xml:"IpScope"` // IP scope.
}
// NetworkConfiguration the configuration applied to a network. This is an abstract base type. The concrete types include thos for vApp and Organization wide networks.
// Type: NetworkConfigurationType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: The configurations applied to a network. This is an abstract base type. The concrete types include those for vApp and Organization wide networks.
// Since: 0.9
type NetworkConfiguration struct {
BackwardCompatibilityMode bool `xml:"BackwardCompatibilityMode"`
Features *NetworkFeatures `xml:"Features,omitempty"`
ParentNetwork *Reference `xml:"ParentNetwork,omitempty"`
IPScopes *IPScopes `xml:"IpScopes,omitempty"`
FenceMode string `xml:"FenceMode"`
RetainNetInfoAcrossDeployments bool `xml:"RetainNetInfoAcrossDeployments"`
// TODO: Not Implemented
// RouterInfo RouterInfo `xml:"RouterInfo,omitempty"`
// SyslogServerSettings SyslogServerSettings `xml:"SyslogServerSettings,omitempty"`
}
// VAppNetworkConfiguration representa a vApp network configuration
// Type: VAppNetworkConfigurationType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a vApp network configuration.
// Since: 0.9
type VAppNetworkConfiguration struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
NetworkName string `xml:"networkName,attr"`
Configuration *NetworkConfiguration `xml:"Configuration"`
Description string `xml:"Description,omitempty"`
IsDeployed bool `xml:"IsDeployed"`
Link *Link `xml:"Link,omitempty"`
}
// NetworkConfigSection is container for vApp networks.
// Type: NetworkConfigSectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for vApp networks.
// Since: 0.9
type NetworkConfigSection struct {
// Extends OVF Section_Type
// FIXME: Fix the OVF section
Info string `xml:"ovf:Info"`
//
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Link *Link `xml:"Link,omitempty"`
NetworkConfig *VAppNetworkConfiguration `xml:"NetworkConfig,omitempty"`
}
// NetworkConnection represents a network connection in the virtual machine.
// Type: NetworkConnectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a network connection in the virtual machine.
// Since: 0.9
type NetworkConnection struct {
Network string `xml:"network,attr"` // Name of the network to which this NIC is connected.
NetworkConnectionIndex int `xml:"NetworkConnectionIndex"` // Virtual slot number associated with this NIC. First slot number is 0.
NeedsCustomization bool `xml:"needsCustomization,attr,omitempty"` // True if this NIC needs customization.
ExternalIPAddress string `xml:"ExternalIpAddress,omitempty"` // If the network to which this NIC connects provides NAT services, the external address assigned to this NIC appears here.
IPAddress string `xml:"IpAddress,omitempty"` // IP address assigned to this NIC.
IsConnected bool `xml:"IsConnected"` // If the virtual machine is undeployed, this value specifies whether the NIC should be connected upon deployment. If the virtual machine is deployed, this value reports the current status of this NIC's connection, and can be updated to change that connection status.
IPAddressAllocationMode string `xml:"IpAddressAllocationMode"` // IP address allocation mode for this connection. One of: POOL (A static IP address is allocated automatically from a pool of addresses.) DHCP (The IP address is obtained from a DHCP service.) MANUAL (The IP address is assigned manually in the IpAddress element.) NONE (No IP addressing mode specified.)
MACAddress string `xml:"MACAddress,omitempty"` // MAC address associated with the NIC.
}
// NetworkConnectionSection the container for the network connections of this virtual machine.
// Type: NetworkConnectionSectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for the network connections of this virtual machine.
// Since: 0.9
type NetworkConnectionSection struct {
// Extends OVF Section_Type
// FIXME: Fix the OVF section
XMLName xml.Name `xml:"NetworkConnectionSection"`
Xmlns string `xml:"xmlns,attr,omitempty"`
Ovf string `xml:"xmlns:ovf,attr,omitempty"`
Info string `xml:"ovf:Info"`
//
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Link *Link `xml:"Link,omitempty"`
PrimaryNetworkConnectionIndex int `xml:"PrimaryNetworkConnectionIndex"`
NetworkConnection *NetworkConnection `xml:"NetworkConnection,omitempty"`
}
// InstantiationParams is a container for ovf:Section_Type elements that specify vApp configuration on instantiate, compose, or recompose.
// Type: InstantiationParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for ovf:Section_Type elements that specify vApp configuration on instantiate, compose, or recompose.
// Since: 0.9
type InstantiationParams struct {
CustomizationSection *CustomizationSection `xml:"CustomizationSection,omitempty"`
DefaultStorageProfileSection *DefaultStorageProfileSection `xml:"DefaultStorageProfileSection,omitempty"`
GuestCustomizationSection *GuestCustomizationSection `xml:"GuestCustomizationSection,omitempty"`
LeaseSettingsSection *LeaseSettingsSection `xml:"LeaseSettingsSection,omitempty"`
NetworkConfigSection *NetworkConfigSection `xml:"NetworkConfigSection,omitempty"`
NetworkConnectionSection *NetworkConnectionSection `xml:"NetworkConnectionSection,omitempty"`
ProductSection *ProductSection `xml:"ProductSection,omitempty"`
// TODO: Not Implemented
// SnapshotSection SnapshotSection `xml:"SnapshotSection,omitempty"`
}
// OrgVDCNetwork represents an Org vDC network in the vCloud model.
// Type: OrgVdcNetworkType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents an Org vDC network in the vCloud model.
// Since: 5.1
type OrgVDCNetwork struct {
XMLName xml.Name `xml:"OrgVdcNetwork"`
Xmlns string `xml:"xmlns,attr,imitempty"`
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Status string `xml:"status,attr,omitempty"`
Configuration *NetworkConfiguration `xml:"Configuration,omitempty"`
Description string `xml:"Description,omitempty"`
EdgeGateway *Reference `xml:"EdgeGateway,omitempty"`
IsShared bool `xml:"IsShared"`
Link []Link `xml:"Link,omitempty"`
ServiceConfig *GatewayFeatures `xml:"ServiceConfig,omitempty"` // Specifies the service configuration for an isolated Org vDC networks
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
}
// SupportedHardwareVersions contains a list of VMware virtual hardware versions supported in this vDC.
// Type: SupportedHardwareVersionsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Contains a list of VMware virtual hardware versions supported in this vDC.
// Since: 1.5
type SupportedHardwareVersions struct {
SupportedHardwareVersion []string `xml:"SupportedHardwareVersion,omitempty"` // A virtual hardware version supported in this vDC.
}
// Capabilities collection of supported hardware capabilities.
// Type: CapabilitiesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Collection of supported hardware capabilities.
// Since: 1.5
type Capabilities struct {
SupportedHardwareVersions *SupportedHardwareVersions `xml:"SupportedHardwareVersions,omitempty"` // Read-only list of virtual hardware versions supported by this vDC.
}
// Vdc represents the user view of an organization vDC.
// Type: VdcType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the user view of an organization vDC.
// Since: 0.9
type Vdc struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Status string `xml:"status,attr,omitempty"`
AllocationModel string `xml:"AllocationModel"`
AvailableNetworks []*AvailableNetworks `xml:"AvailableNetworks,omitempty"`
Capabilities []*Capabilities `xml:"Capabilities,omitempty"`
ComputeCapacity []*ComputeCapacity `xml:"ComputeCapacity"`
Description string `xml:"Description,omitempty"`
IsEnabled bool `xml:"IsEnabled"`
Link LinkList `xml:"Link,omitempty"`
NetworkQuota int `xml:"NetworkQuota"`
NicQuota int `xml:"NicQuota"`
ResourceEntities []*ResourceEntities `xml:"ResourceEntities,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
UsedNetworkCount int `xml:"UsedNetworkCount,omitempty"`
VdcStorageProfiles []*VdcStorageProfiles `xml:"VdcStorageProfiles"`
VMQuota int `xml:"VmQuota"`
}
// Task represents an asynchronous operation in vCloud Director.
// Type: TaskType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents an asynchronous operation in vCloud Director.
// Since: 0.9
type Task struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Status string `xml:"status,attr"`
Operation string `xml:"operation,attr,omitempty"`
OperationName string `xml:"operationName,attr,omitempty"`
ServiceNamespace string `xml:"serviceNamespace,attr,omitempty"`
StartTime string `xml:"startTime,attr,omitempty"`
EndTime string `xml:"endTime,attr,omitempty"`
ExpiryTime string `xml:"expiryTime,attr,omitempty"`
CancelRequested bool `xml:"cancelRequested,attr,omitempty"`
Description string `xml:"Description,omitempty"`
Details string `xml:"Details,omitempty"`
Error *Error `xml:"Error,omitempty"`
Link *Link `xml:"Link,omitempty"`
Organization *Reference `xml:"Organization,omitempty"`
Owner *Reference `xml:"Owner,omitempty"`
Progress int `xml:"Progress,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
User *Reference `xml:"User,omitempty"`
}
// CapacityWithUsage represents a capacity and usage of a given resource.
// Type: CapacityWithUsageType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a capacity and usage of a given resource.
// Since: 0.9
type CapacityWithUsage struct {
Allocated int64 `xml:"Allocated,omitempty"`
Limit int64 `xml:"Limit,omitempty"`
Overhead int64 `xml:"Overhead,omitempty"`
Reserved int64 `xml:"Reserved,omitempty"`
Units string `xml:"Units"`
Used int64 `xml:"Used,omitempty"`
}
// ComputeCapacity represents vDC compute capacity.
// Type: ComputeCapacityType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents vDC compute capacity.
// Since: 0.9
type ComputeCapacity struct {
CPU *CapacityWithUsage `xml:"Cpu"`
Memory *CapacityWithUsage `xml:"Memory"`
}
// Reference is a reference to a resource. Contains an href attribute and optional name and type attributes.
// Type: ReferenceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A reference to a resource. Contains an href attribute and optional name and type attributes.
// Since: 0.9
type Reference struct {
HREF string `xml:"href,attr"`
ID string `xml:"id,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Name string `xml:"name,attr,omitempty"`
}
// ResourceReference represents a reference to a resource. Contains an href attribute, a resource status attribute, and optional name and type attributes.
// Type: ResourceReferenceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a reference to a resource. Contains an href attribute, a resource status attribute, and optional name and type attributes.
// Since: 0.9
type ResourceReference struct {
HREF string `xml:"href,attr"`
ID string `xml:"id,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Name string `xml:"name,attr,omitempty"`
Status string `xml:"status,attr,omitempty"`
}
// VdcStorageProfiles is a container for references to storage profiles associated with a vDC.
// Element: VdcStorageProfiles
// Type: VdcStorageProfilesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for references to storage profiles associated with a vDC.
// Since: 5.1
type VdcStorageProfiles struct {
VdcStorageProfile []*Reference `xml:"VdcStorageProfile,omitempty"`
}
// ResourceEntities is a container for references to ResourceEntity objects in this vDC.
// Type: ResourceEntitiesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for references to ResourceEntity objects in this vDC.
// Since: 0.9
type ResourceEntities struct {
ResourceEntity []*ResourceReference `xml:"ResourceEntity,omitempty"`
}
// AvailableNetworks is a container for references to available organization vDC networks.
// Type: AvailableNetworksType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for references to available organization vDC networks.
// Since: 0.9
type AvailableNetworks struct {
Network []*Reference `xml:"Network,omitempty"`
}
// Link extends reference type by adding relation attribute. Defines a hyper-link with a relationship, hyper-link reference, and an optional MIME type.
// Type: LinkType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Extends reference type by adding relation attribute. Defines a hyper-link with a relationship, hyper-link reference, and an optional MIME type.
// Since: 0.9
type Link struct {
HREF string `xml:"href,attr"`
ID string `xml:"id,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Name string `xml:"name,attr,omitempty"`
Rel string `xml:"rel,attr"`
}
// Org represents the user view of a vCloud Director organization.
// Type: OrgType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the user view of a vCloud Director organization.
// Since: 0.9
type Org struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Description string `xml:"Description,omitempty"`
FullName string `xml:"FullName"`
IsEnabled bool `xml:"IsEnabled,omitempty"`
Link LinkList `xml:"Link,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
}
// CatalogItem contains a reference to a VappTemplate or Media object and related metadata.
// Type: CatalogItemType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Contains a reference to a VappTemplate or Media object and related metadata.
// Since: 0.9
type CatalogItem struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Size int64 `xml:"size,attr,omitempty"`
DateCreated string `xml:"DateCreated,omitempty"`
Description string `xml:"Description,omitempty"`
Entity *Entity `xml:"Entity"`
Link LinkList `xml:"Link,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
VersionNumber int64 `xml:"VersionNumber,omitempty"`
}
// Entity is a basic entity type in the vCloud object model. Includes a name, an optional description, and an optional list of links.
// Type: EntityType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Basic entity type in the vCloud object model. Includes a name, an optional description, and an optional list of links.
// Since: 0.9
type Entity struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Description string `xml:"Description,omitempty"`
Link LinkList `xml:"Link,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
}
// CatalogItems is a container for references to catalog items.
// Type: CatalogItemsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for references to catalog items.
// Since: 0.9
type CatalogItems struct {
CatalogItem []*Reference `xml:"CatalogItem"`
}
// Catalog represents the user view of a Catalog object.
// Type: CatalogType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the user view of a Catalog object.
// Since: 0.9
type Catalog struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
CatalogItems []*CatalogItems `xml:"CatalogItems"`
DateCreated string `xml:"DateCreated"`
Description string `xml:"Description"`
IsPublished bool `xml:"IsPublished"`
Link LinkList `xml:"Link"`
Owner *Owner `xml:"Owner,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
VersionNumber int64 `xml:"VersionNumber"`
}
// Owner represents the owner of this entity.
// Type: OwnerType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the owner of this entity.
// Since: 1.5
type Owner struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Link LinkList `xml:"Link,omitempty"`
User *Reference `xml:"User"`
}
// Error is the standard error message type used in the vCloud REST API.
// Type: ErrorType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: The standard error message type used in the vCloud REST API.
// Since: 0.9
type Error struct {
Message string `xml:"message,attr"`
MajorErrorCode int `xml:"majorErrorCode,attr"`
MinorErrorCode string `xml:"minorErrorCode,attr"`
VendorSpecificErrorCode string `xml:"vendorSpecificErrorCode,attr,omitempty"`
StackTrace string `xml:"stackTrace,attr,omitempty"`
}
// File represents a file to be transferred (uploaded or downloaded).
// Type: FileType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a file to be transferred (uploaded or downloaded).
// Since: 0.9
type File struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
ID string `xml:"id,attr,omitempty"`
OperationKey string `xml:"operationKey,attr,omitempty"`
Name string `xml:"name,attr"`
Size int64 `xml:"size,attr,omitempty"`
BytesTransferred int64 `xml:"bytesTransferred,attr,omitempty"`
Checksum string `xml:"checksum,attr,omitempty"`
Description string `xml:"Description,omitempty"`
Link LinkList `xml:"Link,omitempty"`
Tasks *TasksInProgress `xml:"Tasks,omitempty"`
}
// FilesList represents a list of files to be transferred (uploaded or downloaded).
// Type: FilesListType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a list of files to be transferred (uploaded or downloaded).
// Since: 0.9
type FilesList struct {
File []*File `xml:"File"`
}
// UndeployVAppParams parameters to an undeploy vApp request.
// Type: UndeployVAppParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Parameters to an undeploy vApp request.
// Since: 0.9
type UndeployVAppParams struct {
Xmlns string `xml:"xmlns,attr"`
UndeployPowerAction string `xml:"UndeployPowerAction,omitempty"`
}
// VMCapabilities allows you to specify certain capabilities of this virtual machine.
// Type: VmCapabilitiesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Allows you to specify certain capabilities of this virtual machine.
// Since: 5.1
type VMCapabilities struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
CPUHotAddEnabled bool `xml:"CpuHotAddEnabled,omitempty"`
Link LinkList `xml:"Link,omitempty"`
MemoryHotAddEnabled bool `xml:"MemoryHotAddEnabled,omitempty"`
}
// VMs represents a list of virtual machines.
// Type: VmsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a list of virtual machines.
// Since: 5.1
type VMs struct {
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Link LinkList `xml:"Link,omitempty"`
VMReference []*Reference `xml:"VmReference,omitempty"`
}
/*
* Types that are completely valid (position, comment, coverage complete)
*/
// ComposeVAppParams represetns vApp composition parameters
// Type: ComposeVAppParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents vApp composition parameters.
// Since: 0.9
type ComposeVAppParams struct {
XMLName xml.Name `xml:"ComposeVAppParams"`
Ovf string `xml:"xmlns:ovf,attr"`
Xsi string `xml:"xmlns:xsi,attr"`
Xmlns string `xml:"xmlns,attr"`
// Attributes
Name string `xml:"name,attr,omitempty"` // Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
Deploy bool `xml:"deploy,attr"` // True if the vApp should be deployed at instantiation. Defaults to true.
PowerOn bool `xml:"powerOn,attr"` // True if the vApp should be powered-on at instantiation. Defaults to true.
LinkedClone bool `xml:"linkedClone,attr,omitempty"` // Reserved. Unimplemented.
// Elements
Description string `xml:"Description,omitempty"` // Optional description.
VAppParent *Reference `xml:"VAppParent,omitempty"` // Reserved. Unimplemented.
InstantiationParams *InstantiationParams `xml:"InstantiationParams,omitempty"` // Instantiation parameters for the composed vApp.
SourcedItem *SourcedCompositionItemParam `xml:"SourcedItem,omitempty"` // Composition item. One of: vApp vAppTemplate Vm.
AllEULAsAccepted bool `xml:"AllEULAsAccepted,omitempty"` // True confirms acceptance of all EULAs in a vApp template. Instantiation fails if this element is missing, empty, or set to false and one or more EulaSection elements are present.
}
// SourcedCompositionItemParam represents a vApp, vApp template or Vm to include in a composed vApp.
// Type: SourcedCompositionItemParamType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a vApp, vApp template or Vm to include in a composed vApp.
// Since: 0.9
type SourcedCompositionItemParam struct {
// Attributes
SourceDelete bool `xml:"sourceDelete,attr,omitempty"` // True if the source item should be deleted after composition is complete.
// Elements
Source *Reference `xml:"Source"` // Reference to a vApp, vApp template or virtual machine to include in the composition. Changing the name of the newly created VM by specifying name attribute is deprecated. Include VmGeneralParams element instead.
VMGeneralParams *VMGeneralParams `xml:"VmGeneralParams,omitempty"` // Specify name, description, and other properties of a VM during instantiation.
VAppScopedLocalID string `xml:"VAppScopedLocalId,omitempty"` // If Source references a Vm, this value provides a unique identifier for the Vm in the scope of the composed vApp.
InstantiationParams *InstantiationParams `xml:"InstantiationParams,omitempty"` // If Source references a Vm this can include any of the following OVF sections: VirtualHardwareSection OperatingSystemSection NetworkConnectionSection GuestCustomizationSection.
NetworkAssignment *NetworkAssignment `xml:"NetworkAssignment,omitempty"` // If Source references a Vm, this element maps a network name specified in the Vm to the network name of a vApp network defined in the composed vApp.
StorageProfile *Reference `xml:"StorageProfile,omitempty"` // If Source references a Vm, this element contains a reference to a storage profile to be used for the Vm. The specified storage profile must exist in the organization vDC that contains the composed vApp. If not specified, the default storage profile for the vDC is used.
LocalityParams *LocalityParams `xml:"LocalityParams,omitempty"` // Represents locality parameters. Locality parameters provide a hint that may help the placement engine optimize placement of a VM and an independent a Disk so that the VM can make efficient use of the disk.
}
// LocalityParams represents locality parameters. Locality parameters provide a hint that may help the placement engine optimize placement of a VM with respect to another VM or an independent disk.
// Type: LocalityParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents locality parameters. Locality parameters provide a hint that may help the placement engine optimize placement of a VM with respect to another VM or an independent disk.
// Since: 5.1
type LocalityParams struct {
// Elements
ResourceEntity *Reference `xml:"ResourceEntity,omitempty"` // Reference to a Disk, or a VM.
}
// NetworkAssignment maps a network name specified in a Vm to the network name of a vApp network defined in the VApp that contains the Vm
// Type: NetworkAssignmentType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Maps a network name specified in a Vm to the network name of a vApp network defined in the VApp that contains the Vm
// Since: 0.9
type NetworkAssignment struct {
// Attributes
InnerNetwork string `xml:"innerNetwork,attr"` // Name of the network as specified in the Vm.
ContainerNetwork string `xml:"containerNetwork,attr"` // Name of the vApp network to map to.
}
// VMGeneralParams a set of overrides to source VM properties to apply to target VM during copying.
// Type: VmGeneralParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A set of overrides to source VM properties to apply to target VM during copying.
// Since: 5.6
type VMGeneralParams struct {
// Elements
Name string `xml:"Name,omitempty"` // Name of VM
Description string `xml:"Description,omitempty"` // VM description
NeedsCustomization bool `xml:"NeedsCustomization,omitempty"` // True if this VM needs guest customization
}
// VApp representa a vApp
// Type: VAppType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a vApp.
// Since: 0.9
type VApp struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
ID string `xml:"id,attr,omitempty"` // The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
OperationKey string `xml:"operationKey,attr,omitempty"` // Optional unique identifier to support idempotent semantics for create and delete operations.
Name string `xml:"name,attr"` // The name of the entity.
Status int `xml:"status,attr,omitempty"` // Creation status of the resource entity.
Deployed bool `xml:"deployed,attr,omitempty"` // True if the virtual machine is deployed.
OvfDescriptorUploaded bool `xml:"ovfDescriptorUploaded,attr,omitempty"` // Read-only indicator that the OVF descriptor for this vApp has been uploaded.
// Elements
Link LinkList `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
Description string `xml:"Description,omitempty"` // Optional description.
Tasks *TasksInProgress `xml:"Tasks,omitempty"` // A list of queued, running, or recently completed tasks associated with this entity.
Files *FilesList `xml:"Files,omitempty"` // Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
VAppParent *Reference `xml:"VAppParent,omitempty"` // Reserved. Unimplemented.
// TODO: OVF Sections to be implemented
// Section OVF_Section `xml:"Section"`
DateCreated string `xml:"DateCreated,omitempty"` // Creation date/time of the vApp.
Owner *Owner `xml:"Owner,omitempty"` // vApp owner.
InMaintenanceMode bool `xml:"InMaintenanceMode,omitempty"` // True if this vApp is in maintenance mode. Prevents users from changing vApp metadata.
Children *VAppChildren `xml:"Children,omitempty"` // Container for virtual machines included in this vApp.
ProductSection *ProductSection `xml:"ProductSection,omitempty"`
}
type ProductSectionList struct {
XMLName xml.Name `xml:"ProductSectionList"`
Ovf string `xml:"xmlns:ovf,attr,omitempty"`
Xmlns string `xml:"xmlns,attr"`
ProductSection *ProductSection `xml:"http://schemas.dmtf.org/ovf/envelope/1 ProductSection,omitempty"`
}
type ProductSection struct {
Info string `xml:"Info,omitempty"`
Property []*Property `xml:"http://schemas.dmtf.org/ovf/envelope/1 Property,omitempty"`
}
type Property struct {
Key string `xml:"http://schemas.dmtf.org/ovf/envelope/1 key,attr,omitempty"`
Label string `xml:"http://schemas.dmtf.org/ovf/envelope/1 Label,omitempty"`
Description string `xml:"http://schemas.dmtf.org/ovf/envelope/1 Description,omitempty"`
DefaultValue string `xml:"http://schemas.dmtf.org/ovf/envelope/1 value,attr"`
Value *Value `xml:"http://schemas.dmtf.org/ovf/envelope/1 Value,omitempty"`
Type string `xml:"http://schemas.dmtf.org/ovf/envelope/1 type,attr,omitempty"`
UserConfigurable bool `xml:"http://schemas.dmtf.org/ovf/envelope/1 userConfigurable,attr"`
}
type Value struct {
Value string `xml:"http://schemas.dmtf.org/ovf/envelope/1 value,attr,omitempty"`
}
type MetadataValue struct {
XMLName xml.Name `xml:"MetadataValue"`
Xsi string `xml:"xmlns:xsi,attr"`
Xmlns string `xml:"xmlns,attr"`
TypedValue *TypedValue `xml:"TypedValue"`
}
type TypedValue struct {
XsiType string `xml:"xsi:type,attr"`
Value string `xml:"Value"`
}
// VAppChildren is a container for virtual machines included in this vApp.
// Type: VAppChildrenType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for virtual machines included in this vApp.
// Since: 0.9
type VAppChildren struct {
VM []*VM `xml:"Vm,omitempty"` // Rerpresents a virtual machine.
}
// TasksInProgress is a list of queued, running, or recently completed tasks.
// Type: TasksInProgressType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A list of queued, running, or recently completed tasks.
// Since: 0.9
type TasksInProgress struct {
// Elements
Task []*Task `xml:"Task"` // A task.
}
// VAppTemplateChildren is a container for virtual machines included in this vApp template.
// Type: VAppTemplateChildrenType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for virtual machines included in this vApp template.
// Since: 0.9
type VAppTemplateChildren struct {
// Elements
VM []*VAppTemplate `xml:"Vm"` // Represents a virtual machine in this vApp template.
}
// VAppTemplate represents a vApp template.
// Type: VAppTemplateType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a vApp template.
// Since: 0.9
type VAppTemplate struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
ID string `xml:"id,attr,omitempty"` // The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
OperationKey string `xml:"operationKey,attr,omitempty"` // Optional unique identifier to support idempotent semantics for create and delete operations.
Name string `xml:"name,attr"` // The name of the entity.
Status int `xml:"status,attr,omitempty"` // Creation status of the resource entity.
OvfDescriptorUploaded string `xml:"ovfDescriptorUploaded,attr,omitempty"` // True if the OVF descriptor for this template has been uploaded.
GoldMaster bool `xml:"goldMaster,attr,omitempty"` // True if this template is a gold master.
// Elements
Link LinkList `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
Description string `xml:"Description,omitempty"` // Optional description.
Tasks *TasksInProgress `xml:"Tasks,omitempty"` // A list of queued, running, or recently completed tasks associated with this entity.
Files *FilesList `xml:"Files,omitempty"` // Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
Owner *Owner `xml:"Owner,omitempty"` // vAppTemplate owner.
Children *VAppTemplateChildren `xml:"Children,omitempty"` // Container for virtual machines included in this vApp template.
VAppScopedLocalID string `xml:"VAppScopedLocalId"` // A unique identifier for the Vm in the scope of the vApp template.
DefaultStorageProfile string `xml:"DefaultStorageProfile,omitempty"` // The name of the storage profile to be used for this object. The named storage profile must exist in the organization vDC that contains the object. If not specified, the default storage profile for the vDC is used.
DateCreated string `xml:"DateCreated,omitempty"` // Creation date/time of the template.
// FIXME: Upstream bug? Missing NetworkConfigSection, LeaseSettingSection and
// CustomizationSection at least, NetworkConnectionSection is required when
// using ComposeVApp action in the context of a Children VM (still
// referenced by VAppTemplateType).
NetworkConfigSection *NetworkConfigSection `xml:"NetworkConfigSection,omitempty"`
NetworkConnectionSection *NetworkConnectionSection `xml:"NetworkConnectionSection,omitempty"`
LeaseSettingsSection *LeaseSettingsSection `xml:"LeaseSettingsSection,omitempty"`
CustomizationSection *CustomizationSection `xml:"CustomizationSection,omitempty"`
// OVF Section needs to be added
// Section Section `xml:"Section,omitempty"`
}
// VM represents a virtual machine
// Type: VmType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a virtual machine.
// Since: 0.9
type VM struct {
// Attributes
XMLName xml.Name `xml:"Vm"`
Ovf string `xml:"xmlns:ovf,attr,omitempty"`
Xsi string `xml:"xmlns:xsi,attr,omitempty"`
Xmlns string `xml:"xmlns,attr,omitempty"`
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
ID string `xml:"id,attr,omitempty"` // The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused
OperationKey string `xml:"operationKey,attr,omitempty"` // Optional unique identifier to support idempotent semantics for create and delete operations.
Name string `xml:"name,attr"` // The name of the entity.
Status int `xml:"status,attr,omitempty"` // Creation status of the resource entity.
Deployed bool `xml:"deployed,attr,omitempty"` // True if the virtual machine is deployed.
NeedsCustomization bool `xml:"needsCustomization,attr,omitempty"` // True if this virtual machine needs customization.
NestedHypervisorEnabled bool `xml:"nestedHypervisorEnabled,attr,omitempty"` // True if hardware-assisted CPU virtualization capabilities in the host should be exposed to the guest operating system.
// Elements
Link LinkList `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
Description string `xml:"Description,omitempty"` // Optional description.
Tasks *TasksInProgress `xml:"Tasks,omitempty"` // A list of queued, running, or recently completed tasks associated with this entity.
Files *FilesList `xml:"FilesList,omitempty"` // Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
VAppParent *Reference `xml:"VAppParent,omitempty"` // Reserved. Unimplemented.
// TODO: OVF Sections to be implemented
// Section OVF_Section `xml:"Section,omitempty"
DateCreated string `xml:"DateCreated,omitempty"` // Creation date/time of the vApp.
// Section ovf:VirtualHardwareSection
VirtualHardwareSection *VirtualHardwareSection `xml:"VirtualHardwareSection,omitempty"`
// FIXME: Upstream bug? Missing NetworkConnectionSection
NetworkConnectionSection *NetworkConnectionSection `xml:"NetworkConnectionSection,omitempty"`
VAppScopedLocalID string `xml:"VAppScopedLocalId,omitempty"` // A unique identifier for the virtual machine in the scope of the vApp.
Snapshots *SnapshotSection `xml:"SnapshotSection,omitempty"`
// TODO: OVF Sections to be implemented
// Environment OVF_Environment `xml:"Environment,omitempty"
VMCapabilities *VMCapabilities `xml:"VmCapabilities,omitempty"` // Allows you to specify certain capabilities of this virtual machine.
StorageProfile *Reference `xml:"StorageProfile,omitempty"` // A reference to a storage profile to be used for this object. The specified storage profile must exist in the organization vDC that contains the object. If not specified, the default storage profile for the vDC is used.
ProductSection *ProductSection `xml:"ProductSection,omitempty"`
}
// ovf:VirtualHardwareSection from VM struct
type VirtualHardwareSection struct {
// Extends OVF Section_Type
XMLName xml.Name `xml:"VirtualHardwareSection"`
Xmlns string `xml:"vcloud,attr,omitempty"`
Info string `xml:"Info"`
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Item []*VirtualHardwareItem `xml:"Item,omitempty"`
}
// Each ovf:Item parsed from the ovf:VirtualHardwareSection
type VirtualHardwareItem struct {
XMLName xml.Name `xml:"Item"`
ResourceType int `xml:"ResourceType,omitempty"`
ResourceSubType string `xml:"ResourceSubType,omitempty"`
ElementName string `xml:"ElementName,omitempty"`
Description string `xml:"Description,omitempty"`
InstanceID int `xml:"InstanceID,omitempty"`
AutomaticAllocation bool `xml:"AutomaticAllocation,omitempty"`
Address string `xml:"Address,omitempty"`
AddressOnParent int `xml:"AddressOnParent,omitempty"`
AllocationUnits string `xml:"AllocationUnits,omitempty"`
Reservation int `xml:"Reservation,omitempty"`
VirtualQuantity int `xml:"VirtualQuantity,omitempty"`
Weight int `xml:"Weight,omitempty"`
CoresPerSocket int `xml:"CoresPerSocket,omitempty"`
Connection []*VirtualHardwareConnection `xml:"Connection,omitempty"`
HostResource []*VirtualHardwareHostResource `xml:"HostResource,omitempty"`
Link []*Link `xml:"Link,omitempty"`
}
// Connection info from ResourceType=10 (Network Interface)
type VirtualHardwareConnection struct {
IPAddress string `xml:"ipAddress,attr,omitempty"`
PrimaryConnection bool `xml:"primaryNetworkConnection,attr,omitempty"`
IpAddressingMode string `xml:"ipAddressingMode,attr,omitempty"`
NetworkName string `xml:",chardata"`
}
// HostResource info from ResourceType=17 (Hard Disk)
type VirtualHardwareHostResource struct {
BusType int `xml:"busType,attr,omitempty"`
BusSubType string `xml:"busSubType,attr,omitempty"`
Capacity int `xml:"capacity,attr,omitempty"`
StorageProfile string `xml:"storageProfileHref,attr,omitempty"`
OverrideVmDefault bool `xml:"storageProfileOverrideVmDefault,attr,omitempty"`
}
// SnapshotSection from VM struct
type SnapshotSection struct {
// Extends OVF Section_Type
XMLName xml.Name `xml:"SnapshotSection"`
Info string `xml:"Info"`
HREF string `xml:"href,attr,omitempty"`
Type string `xml:"type,attr,omitempty"`
Snapshot []*SnapshotItem `xml:"Snapshot,omitempty"`
}
// Each snapshot listed in the SnapshotSection
type SnapshotItem struct {
Created string `xml:"created,attr,omitempty"`
PoweredOn bool `xml:"poweredOn,attr,omitempty"`
Size int `xml:"size,attr,omitempty"`
}
// OVFItem is a horrible kludge to process OVF, needs to be fixed with proper types.
type OVFItem struct {
XMLName xml.Name `xml:"vcloud:Item"`
XmlnsRasd string `xml:"xmlns:rasd,attr"`
XmlnsVCloud string `xml:"xmlns:vcloud,attr"`
XmlnsXsi string `xml:"xmlns:xsi,attr"`
VCloudHREF string `xml:"vcloud:href,attr"`
VCloudType string `xml:"vcloud:type,attr"`
AllocationUnits string `xml:"rasd:AllocationUnits"`
Description string `xml:"rasd:Description"`
ElementName string `xml:"rasd:ElementName"`
InstanceID int `xml:"rasd:InstanceID"`
Reservation int `xml:"rasd:Reservation"`
ResourceType int `xml:"rasd:ResourceType"`
VirtualQuantity int `xml:"rasd:VirtualQuantity"`
Weight int `xml:"rasd:Weight"`
Link *Link `xml:"vcloud:Link"`
}
// DeployVAppParams are the parameters to a deploy vApp request
// Type: DeployVAppParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Parameters to a deploy vApp request.
// Since: 0.9
type DeployVAppParams struct {
XMLName xml.Name `xml:"DeployVAppParams"`
Xmlns string `xml:"xmlns,attr"`
// Attributes
PowerOn bool `xml:"powerOn,attr"` // Used to specify whether to power on vapp on deployment, if not set default value is true.
DeploymentLeaseSeconds int `xml:"deploymentLeaseSeconds,attr,omitempty"` // Lease in seconds for deployment. A value of 0 is replaced by the organization default deploymentLeaseSeconds value.
ForceCustomization bool `xml:"forceCustomization,attr,omitempty"` // Used to specify whether to force customization on deployment, if not set default value is false
}
// GuestCustomizationSection represents guest customization settings
// Type: GuestCustomizationSectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a guest customization settings.
// Since: 1.0
type GuestCustomizationSection struct {
// Extends OVF Section_Type
// Attributes
Ovf string `xml:"xmlns:ovf,attr,omitempty"`
Xsi string `xml:"xmlns:xsi,attr,omitempty"`
Xmlns string `xml:"xmlns,attr,omitempty"`
HREF string `xml:"href,attr,omitempty"` // A reference to the section in URL format.
Type string `xml:"type,attr,omitempty"` // The MIME type of the section.
// FIXME: Fix the OVF section
Info string `xml:"ovf:Info"`
// Elements
Enabled bool `xml:"Enabled,omitempty"` // True if guest customization is enabled.
ChangeSid bool `xml:"ChangeSid,omitempty"` // True if customization can change the Windows SID of this virtual machine.
VirtualMachineID string `xml:"VirtualMachineId,omitempty"` // Virtual machine ID to apply.
JoinDomainEnabled bool `xml:"JoinDomainEnabled,omitempty"` // True if this virtual machine can join a Windows Domain.
UseOrgSettings bool `xml:"UseOrgSettings,omitempty"` // True if customization should use organization settings (OrgGuestPersonalizationSettings) when joining a Windows Domain.
DomainName string `xml:"DomainName,omitempty"` // The name of the Windows Domain to join.
DomainUserName string `xml:"DomainUserName,omitempty"` // User name to specify when joining a Windows Domain.
DomainUserPassword string `xml:"DomainUserPassword,omitempty"` // Password to use with DomainUserName.
MachineObjectOU string `xml:"MachineObjectOU,omitempty"` // The name of the Windows Domain Organizational Unit (OU) in which the computer account for this virtual machine will be created.
AdminPasswordEnabled bool `xml:"AdminPasswordEnabled,omitempty"` // True if guest customization can modify administrator password settings for this virtual machine.
AdminPasswordAuto bool `xml:"AdminPasswordAuto,omitempty"` // True if the administrator password for this virtual machine should be automatically generated.
AdminPassword string `xml:"AdminPassword,omitempty"` // True if the administrator password for this virtual machine should be set to this string. (AdminPasswordAuto must be false.)
AdminAutoLogonEnabled bool `xml:"AdminAutoLogonEnabled,omitempty"` // True if guest administrator should automatically log into this virtual machine.
AdminAutoLogonCount int `xml:"AdminAutoLogonCount,omitempty"` // Number of times administrator can automatically log into this virtual machine. In case AdminAutoLogon is set to True, this value should be between 1 and 100. Otherwise, it should be 0.
ResetPasswordRequired bool `xml:"ResetPasswordRequired,omitempty"` // True if the administrator password for this virtual machine must be reset after first use.
CustomizationScript string `xml:"CustomizationScript,omitempty"` // Script to run on guest customization. The entire script must appear in this element. Use the XML entity 
 to represent a newline. Unicode characters can be represented in the form &#xxxx; where xxxx is the character number.
ComputerName string `xml:"ComputerName,omitempty"` // Computer name to assign to this virtual machine.
Link LinkList `xml:"Link,omitempty"` // A link to an operation on this section.
}
// InstantiateVAppTemplateParams represents vApp template instantiation parameters.
// Type: InstantiateVAppTemplateParamsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents vApp template instantiation parameters.
// Since: 0.9
type InstantiateVAppTemplateParams struct {
XMLName xml.Name `xml:"InstantiateVAppTemplateParams"`
Ovf string `xml:"xmlns:ovf,attr"`
Xsi string `xml:"xmlns:xsi,attr,omitempty"`
Xmlns string `xml:"xmlns,attr"`
// Attributes
Name string `xml:"name,attr,omitempty"` // Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
Deploy bool `xml:"deploy,attr"` // True if the vApp should be deployed at instantiation. Defaults to true.
PowerOn bool `xml:"powerOn,attr"` // True if the vApp should be powered-on at instantiation. Defaults to true.
LinkedClone bool `xml:"linkedClone,attr,omitempty"` // Reserved. Unimplemented.
// Elements
Description string `xml:"Description,omitempty"` // Optional description.
VAppParent *Reference `xml:"VAppParent,omitempty"` // Reserved. Unimplemented.
InstantiationParams *InstantiationParams `xml:"InstantiationParams,omitempty"` // Instantiation parameters for the composed vApp.
Source *Reference `xml:"Source"` // A reference to a source object such as a vApp or vApp template.
IsSourceDelete bool `xml:"IsSourceDelete,omitempty"` // Set to true to delete the source object after the operation completes.
SourcedItem *SourcedCompositionItemParam `xml:"SourcedItem,omitempty"` // Composition item. One of: vApp vAppTemplate Vm.
AllEULAsAccepted bool `xml:"AllEULAsAccepted,omitempty"` // True confirms acceptance of all EULAs in a vApp template. Instantiation fails if this element is missing, empty, or set to false and one or more EulaSection elements are present.
}
// EdgeGateway represents a gateway.
// Element: EdgeGateway
// Type: GatewayType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a gateway.
// Since: 5.1
type EdgeGateway struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
ID string `xml:"id,attr,omitempty"` // The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused
OperationKey string `xml:"operationKey,attr,omitempty"` // Optional unique identifier to support idempotent semantics for create and delete operations.
Name string `xml:"name,attr"` // The name of the entity.
Status int `xml:"status,attr,omitempty"` // Creation status of the gateway. One of: 0 (The gateway is still being created) 1 (The gateway is ready) -1 (There was an error while creating the gateway).
// Elements
Link LinkList `xml:"Link,omitempty"` // A link to an operation on this section.
Description string `xml:"Description,omitempty"` // Optional description.
Tasks *TasksInProgress `xml:"Tasks,omitempty"` // A list of queued, running, or recently completed tasks associated with this entity.
Configuration *GatewayConfiguration `xml:"Configuration"` // Gateway configuration.
}
// GatewayConfiguration is the gateway configuration
// Type: GatewayConfigurationType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Gateway Configuration.
// Since: 5.1
type GatewayConfiguration struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
BackwardCompatibilityMode bool `xml:"BackwardCompatibilityMode,omitempty"` // Compatibilty mode. Default is false. If set to true, will allow users to write firewall rules in the old 1.5 format. The new format does not require to use direction in firewall rules. Also, for firewall rules to allow NAT traffic the filter is applied on the original IP addresses. Once set to true cannot be reverted back to false.
GatewayBackingConfig string `xml:"GatewayBackingConfig"` // Configuration of the vShield edge VM for this gateway. One of: compact, full.
GatewayInterfaces *GatewayInterfaces `xml:"GatewayInterfaces"` // List of Gateway interfaces.
EdgeGatewayServiceConfiguration *GatewayFeatures `xml:"EdgeGatewayServiceConfiguration,omitempty"` // Represents Gateway Features.
HaEnabled bool `xml:"HaEnabled,omitempty"` // True if this gateway is highly available. (Requires two vShield edge VMs.)
UseDefaultRouteForDNSRelay bool `xml:"UseDefaultRouteForDnsRelay,omitempty"` // True if the default gateway on the external network selected for default route should be used as the DNS relay.
}
// GatewayInterfaces is a list of Gateway Interfaces.
// Type: GatewayInterfacesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: A list of Gateway Interfaces.
// Since: 5.1
type GatewayInterfaces struct {
GatewayInterface []*GatewayInterface `xml:"GatewayInterface"` // Gateway Interface.
}
// GatewayInterface is a gateway interface configuration.
// Type: GatewayInterfaceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Gateway Interface configuration.
// Since: 5.1
type GatewayInterface struct {
Name string `xml:"Name,omitempty"` // Internally generated name for the Gateway Interface.
DisplayName string `xml:"DisplayName,omitempty"` // Gateway Interface display name.
Network *Reference `xml:"Network"` // A reference to the network connected to the gateway interface.
InterfaceType string `xml:"InterfaceType"` // The type of interface: One of: Uplink, Internal
SubnetParticipation *SubnetParticipation `xml:"SubnetParticipation,omitempty"` // IP allocation per subnet.
ApplyRateLimit bool `xml:"ApplyRateLimit,omitempty"` // True if rate limiting is applied on this interface.
InRateLimit float64 `xml:"InRateLimit,omitempty"` // Incoming rate limit expressed as Gbps.
OutRateLimit float64 `xml:"OutRateLimit,omitempty"` // Outgoing rate limit expressed as Gbps.
UseForDefaultRoute bool `xml:"UseForDefaultRoute,omitempty"` // True if this network is default route for the gateway.
}
// SubnetParticipation allows to chose which subnets a gateway can be a part of
// Type: SubnetParticipationType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Allows to chose which subnets a gateway can be part of
// Since: 5.1
type SubnetParticipation struct {
Gateway string `xml:"Gateway"` // Gateway for subnet
IPAddress string `xml:"IpAddress,omitempty"` // Ip Address to be assigned. Keep empty or ommit element for auto assignment
IPRanges *IPRanges `xml:"IpRanges,omitempty"` // Range of IP addresses available for external interfaces.
Netmask string `xml:"Netmask"` // Nestmask for the subnet
}
type EdgeGatewayServiceConfiguration struct {
XMLName xml.Name `xml:"EdgeGatewayServiceConfiguration"`
Xmlns string `xml:"xmlns,attr,omitempty"`
GatewayDhcpService *GatewayDhcpService `xml:"GatewayDhcpService,omitempty"`
FirewallService *FirewallService `xml:"FirewallService,omitempty"`
NatService *NatService `xml:"NatService,omitempty"`
}
// GatewayFeatures represents edge gateway services.
// Element: EdgeGatewayServiceConfiguration
// Type: GatewayFeaturesType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents edge gateway services.
// Since: 5.1
type GatewayFeatures struct {
XMLName xml.Name
Xmlns string `xml:"xmlns,attr,omitempty"`
FirewallService *FirewallService `xml:"FirewallService,omitempty"` // Substitute for NetworkService. Firewall service settings
NatService *NatService `xml:"NatService,omitempty"` // Substitute for NetworkService. NAT service settings
GatewayDhcpService *GatewayDhcpService `xml:"GatewayDhcpService,omitempty"` // Substitute for NetworkService. Gateway DHCP service settings
GatewayIpsecVpnService *GatewayIpsecVpnService `xml:"GatewayIpsecVpnService,omitempty"` // Substitute for NetworkService. Gateway Ipsec VPN service settings
LoadBalancerService *LoadBalancerService `xml:"LoadBalancerService,omitempty"` // Substitute for NetworkService. Load Balancer service settings
StaticRoutingService *StaticRoutingService `xml:"StaticRoutingService,omitempty"` // Substitute for NetworkService. Static Routing service settings
}
// StaticRoutingService represents Static Routing network service.
// Type: StaticRoutingServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents Static Routing network service.
// Since: 1.5
type StaticRoutingService struct {
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
StaticRoute *StaticRoute `xml:"StaticRoute,omitempty"` // Details of each Static Route.
}
// StaticRoute represents a static route entry
// Type: StaticRouteType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description:
// Since:
type StaticRoute struct {
Name string `xml:"Name"` // Name for the static route.
Network string `xml:"Network"` // Network specification in CIDR.
NextHopIP string `xml:"NextHopIp"` // IP Address of Next Hop router/gateway.
Interface string `xml:"Interface,omitempty"` // Interface to use for static routing. Internal and External are the supported values.
GatewayInterface *Reference `xml:"GatewayInterface,omitempty"` // Gateway interface to which static route is bound.
}
// LoadBalancerService represents gateway load balancer service.
// Type: LoadBalancerServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents gateway load balancer service.
// Since: 5.1
type LoadBalancerService struct {
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
Pool *LoadBalancerPool `xml:"Pool,omitempty"` // List of load balancer pools.
VirtualServer *LoadBalancerVirtualServer `xml:"VirtualServer,omitempty"` // List of load balancer virtual servers.
}
// LoadBalancerPool represents a load balancer pool.
// Type: LoadBalancerPoolType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a load balancer pool.
// Since: 5.1
type LoadBalancerPool struct {
ID string `xml:"Id,omitempty"` // Load balancer pool id.
Name string `xml:"Name"` // Load balancer pool name.
Description string `xml:"Description,omitempty"` // Load balancer pool description.
ServicePort *LBPoolServicePort `xml:"ServicePort"` // Load balancer pool service port.
Member *LBPoolMember `xml:"Member"` // Load balancer pool member.
Operational bool `xml:"Operational,omitempty"` // True if the load balancer pool is operational.
ErrorDetails string `xml:"ErrorDetails,omitempty"` // Error details for this pool.
}
// LBPoolServicePort represents a service port in a load balancer pool.
// Type: LBPoolServicePortType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a service port in a load balancer pool.
// Since: 5.1
type LBPoolServicePort struct {
IsEnabled bool `xml:"IsEnabled,omitempty"` // True if this service port is enabled.
Protocol string `xml:"Protocol"` // Load balancer protocol type. One of: HTTP, HTTPS, TCP.
Algorithm string `xml:"Algorithm"` // Load Balancer algorithm type. One of: IP_HASH, ROUND_ROBIN, URI, LEAST_CONN.
Port string `xml:"Port"` // Port for this service profile.
HealthCheckPort string `xml:"HealthCheckPort,omitempty"` // Health check port for this profile.
HealthCheck *LBPoolHealthCheck `xml:"HealthCheck,omitempty"` // Health check list.
}
// LBPoolHealthCheck represents a service port health check list.
// Type: LBPoolHealthCheckType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a service port health check list.
// Since: 5.1
type LBPoolHealthCheck struct {
Mode string `xml:"Mode"` // Load balancer service port health check mode. One of: TCP, HTTP, SSL.
URI string `xml:"Uri,omitempty"` // Load balancer service port health check URI.
HealthThreshold string `xml:"HealthThreshold,omitempty"` // Health threshold for this service port.
UnhealthThreshold string `xml:"UnhealthThreshold,omitempty"` // Unhealth check port for this profile.
Interval string `xml:"Interval,omitempty"` // Interval between health checks.
Timeout string `xml:"Timeout,omitempty"` // Health check timeout.
}
// LBPoolMember represents a member in a load balancer pool.
// Type: LBPoolMemberType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a member in a load balancer pool.
// Since: 5.1
type LBPoolMember struct {
IPAddress string `xml:"IpAddress"` // Ip Address for load balancer member.
Weight string `xml:"Weight"` // Weight of this member.
ServicePort *LBPoolServicePort `xml:"ServicePort,omitempty"` // Load balancer member service port.
}
// LoadBalancerVirtualServer represents a load balancer virtual server.
// Type: LoadBalancerVirtualServerType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a load balancer virtual server.
// Since: 5.1
type LoadBalancerVirtualServer struct {
IsEnabled bool `xml:"IsEnabled,omitempty"` // True if this virtual server is enabled.
Name string `xml:"Name"` // Load balancer virtual server name.
Description string `xml:"Description,omitempty"` // Load balancer virtual server description.
Interface *Reference `xml:"Interface"` // Gateway Interface to which Load Balancer Virtual Server is bound.
IPAddress string `xml:"IpAddress"` // Load balancer virtual server Ip Address.
ServiceProfile *LBVirtualServerServiceProfile `xml:"ServiceProfile"` // Load balancer virtual server service profiles.
Logging bool `xml:"Logging,omitempty"` // Enable logging for this virtual server.
Pool string `xml:"Pool"` // Name of Load balancer pool associated with this virtual server.
LoadBalancerTemplates *VendorTemplate `xml:"LoadBalancerTemplates,omitempty"` // Service template related attributes.
}
// LBVirtualServerServiceProfile represents service profile for a load balancing virtual server.
// Type: LBVirtualServerServiceProfileType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents service profile for a load balancing virtual server.
// Since: 5.1
type LBVirtualServerServiceProfile struct {
IsEnabled bool `xml:"IsEnabled,omitempty"` // True if this service profile is enabled.
Protocol string `xml:"Protocol"` // Load balancer Protocol type. One of: HTTP, HTTPS, TCP.
Port string `xml:"Port"` // Port for this service profile.
Persistence *LBPersistence `xml:"Persistence,omitempty"` // Persistence type for service profile.
}
// LBPersistence represents persistence type for a load balancer service profile.
// Type: LBPersistenceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents persistence type for a load balancer service profile.
// Since: 5.1
type LBPersistence struct {
Method string `xml:"Method"` // Persistence method. One of: COOKIE, SSL_SESSION_ID.
CookieName string `xml:"CookieName,omitempty"` // Cookie name when persistence method is COOKIE.
CookieMode string `xml:"CookieMode,omitempty"` // Cookie Mode. One of: INSERT, PREFIX, APP.
}
// VendorTemplate is information about a vendor service template. This is optional.
// Type: VendorTemplateType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Information about a vendor service template. This is optional.
// Since: 5.1
type VendorTemplate struct {
Name string `xml:"Name"` // Name of the vendor template. This is required.
ID string `xml:"Id"` // ID of the vendor template. This is required.
}
// GatewayIpsecVpnService represents gateway IPsec VPN service.
// Type: GatewayIpsecVpnServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents gateway IPsec VPN service.
// Since: 5.1
type GatewayIpsecVpnService struct {
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
Endpoint *GatewayIpsecVpnEndpoint `xml:"Endpoint,omitempty"` // List of IPSec VPN Service Endpoints.
Tunnel []*GatewayIpsecVpnTunnel `xml:"Tunnel"` // List of IPSec VPN tunnels.
}
// GatewayIpsecVpnEndpoint represents an IPSec VPN endpoint.
// Type: GatewayIpsecVpnEndpointType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents an IPSec VPN endpoint.
// Since: 5.1
type GatewayIpsecVpnEndpoint struct {
Network *Reference `xml:"Network"` // External network reference.
PublicIP string `xml:"PublicIp,omitempty"` // Public IP for IPSec endpoint.
}
// GatewayIpsecVpnTunnel represents an IPSec VPN tunnel.
// Type: GatewayIpsecVpnTunnelType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents an IPSec VPN tunnel.
// Since: 5.1
type GatewayIpsecVpnTunnel struct {
Name string `xml:"Name"` // The name of the tunnel.
Description string `xml:"Description,omitempty"` // A description of the tunnel.
// TODO: Fix this in a better way
IpsecVpnThirdPartyPeer *IpsecVpnThirdPartyPeer `xml:"IpsecVpnThirdPartyPeer,omitempty"` // Details about the peer network.
PeerIPAddress string `xml:"PeerIpAddress"` // IP address of the peer endpoint.
PeerID string `xml:"PeerId"` // Id for the peer end point
LocalIPAddress string `xml:"LocalIpAddress"` // Address of the local network.
LocalID string `xml:"LocalId"` // Id for local end point
LocalSubnet *IpsecVpnSubnet `xml:"LocalSubnet"` // List of local subnets in the tunnel.
PeerSubnet *IpsecVpnSubnet `xml:"PeerSubnet"` // List of peer subnets in the tunnel.
SharedSecret string `xml:"SharedSecret"` // Shared secret used for authentication.
SharedSecretEncrypted bool `xml:"SharedSecretEncrypted,omitempty"` // True if shared secret is encrypted.
EncryptionProtocol string `xml:"EncryptionProtocol"` // Encryption protocol to be used. One of: AES, AES256, TRIPLEDES
Mtu int `xml:"Mtu"` // MTU for the tunnel.
IsEnabled bool `xml:"IsEnabled,omitempty"` // True if the tunnel is enabled.
IsOperational bool `xml:"IsOperational,omitempty"` // True if the tunnel is operational.
ErrorDetails string `xml:"ErrorDetails,omitempty"` // Error details of the tunnel.
}
// IpsecVpnThirdPartyPeer represents details about a peer network
type IpsecVpnThirdPartyPeer struct {
PeerID string `xml:"PeerId,omitempty"` // Id for the peer end point
}
// IpsecVpnSubnet represents subnet details.
// Type: IpsecVpnSubnetType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents subnet details.
// Since: 5.1
type IpsecVpnSubnet struct {
Name string `xml:"Name"` // Gateway Name.
Gateway string `xml:"Gateway"` // Subnet Gateway.
Netmask string `xml:"Netmask"` // Subnet Netmask.
}
// GatewayDhcpService represents Gateway DHCP service.
// Type: GatewayDhcpServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents Gateway DHCP service.
// Since: 5.1
type GatewayDhcpService struct {
IsEnabled bool `xml:"IsEnabled,omitempty"` // Enable or disable the service using this flag
Pool []*DhcpPoolService `xml:"Pool,omitempty"` // A DHCP pool.
}
// DhcpPoolService represents DHCP pool service.
// Type: DhcpPoolServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents DHCP pool service.
// Since: 5.1
type DhcpPoolService struct {
IsEnabled bool `xml:"IsEnabled,omitempty"` // True if this DHCP Pool is enabled.
Network *Reference `xml:"Network"` // Org vDC network to which the DHCP range is applicable.
DefaultLeaseTime int `xml:"DefaultLeaseTime,omitempty"` // Default lease period for DHCP range.
MaxLeaseTime int `xml:"MaxLeaseTime"` // Maximum lease period for DHCP range.
LowIPAddress string `xml:"LowIpAddress"` // Low IP address in DHCP range.
HighIPAddress string `xml:"HighIpAddress"` // High IP address in DHCP range.
}
// VMSelection represents details of an vm+nic+iptype selection.
// Type: VmSelectionType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents details of an vm+nic+iptype selection.
// Since: 5.1
type VMSelection struct {
VAppScopedVMID string `xml:"VAppScopedVmId"` // VAppScopedVmId of VM to which this rule applies.
VMNicID int `xml:"VmNicId"` // VM NIC ID to which this rule applies.
IPType string `xml:"IpType"` // The value can be one of:- assigned: assigned internal IP be automatically choosen. NAT: NATed external IP will be automatically choosen.
}
// FirewallRuleProtocols flags for a network protocol in a firewall rule
// Type: FirewallRuleType/Protocols
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description:
// Since:
type FirewallRuleProtocols struct {
ICMP bool `xml:"Icmp,omitempty"` // True if the rule applies to the ICMP protocol.
Any bool `xml:"Any,omitempty"` // True if the rule applies to any protocol.
TCP bool `xml:"Tcp,omitempty"` // True if the rule applies to the TCP protocol.
UDP bool `xml:"Udp,omitempty"` // True if the rule applies to the UDP protocol.
// FIXME: this is supposed to extend protocol support to all the VSM supported protocols
// Other string `xml:"Other,omitempty"` // Any other protocol supported by vShield Manager
}
// FirewallRule represents a firewall rule
// Type: FirewallRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a firewall rule.
// Since: 0.9
type FirewallRule struct {
ID string `xml:"Id,omitempty"` // Firewall rule identifier.
IsEnabled bool `xml:"IsEnabled"` // Used to enable or disable the firewall rule. Default value is true.
MatchOnTranslate bool `xml:"MatchOnTranslate"` // For DNATed traffic, match the firewall rules only after the destination IP is translated.
Description string `xml:"Description,omitempty"` // A description of the rule.
Policy string `xml:"Policy,omitempty"` // One of: drop (drop packets that match the rule), allow (allow packets that match the rule to pass through the firewall)
Protocols *FirewallRuleProtocols `xml:"Protocols,omitempty"` // Specify the protocols to which the rule should be applied.
IcmpSubType string `xml:"IcmpSubType,omitempty"` // ICMP subtype. One of: address-mask-request, address-mask-reply, destination-unreachable, echo-request, echo-reply, parameter-problem, redirect, router-advertisement, router-solicitation, source-quench, time-exceeded, timestamp-request, timestamp-reply, any.
Port int `xml:"Port,omitempty"` // The port to which this rule applies. A value of -1 matches any port.
DestinationPortRange string `xml:"DestinationPortRange,omitempty"` // Destination port range to which this rule applies.
DestinationIP string `xml:"DestinationIp,omitempty"` // Destination IP address to which the rule applies. A value of Any matches any IP address.
DestinationVM *VMSelection `xml:"DestinationVm,omitempty"` // Details of the destination VM
SourcePort int `xml:"SourcePort,omitempty"` // Destination port to which this rule applies. A value of -1 matches any port.
SourcePortRange string `xml:"SourcePortRange,omitempty"` // Source port range to which this rule applies.
SourceIP string `xml:"SourceIp,omitempty"` // Source IP address to which the rule applies. A value of Any matches any IP address.
SourceVM *VMSelection `xml:"SourceVm,omitempty"` // Details of the source Vm
Direction string `xml:"Direction,omitempty"` // Direction of traffic to which rule applies. One of: in (rule applies to incoming traffic. This is the default value), out (rule applies to outgoing traffic).
EnableLogging bool `xml:"EnableLogging"` // Used to enable or disable firewall rule logging. Default value is false.
}
// FirewallService represent a network firewall service.
// Type: FirewallServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a network firewall service.
// Since:
type FirewallService struct {
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
DefaultAction string `xml:"DefaultAction,omitempty"` // Default action of the firewall. One of: drop (Default. Drop packets that match the rule.), allow (Allow packets that match the rule to pass through the firewall)
LogDefaultAction bool `xml:"LogDefaultAction"` // Flag to enable logging for default action. Default value is false.
FirewallRule []*FirewallRule `xml:"FirewallRule,omitempty"` // A firewall rule.
}
// NatService represents a NAT network service.
// Type: NatServiceType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a NAT network service.
// Since:
type NatService struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
IsEnabled bool `xml:"IsEnabled"` // Enable or disable the service using this flag
NatType string `xml:"NatType,omitempty"` // One of: ipTranslation (use IP translation), portForwarding (use port forwarding)
Policy string `xml:"Policy,omitempty"` // One of: allowTraffic (Allow all traffic), allowTrafficIn (Allow inbound traffic only)
NatRule []*NatRule `xml:"NatRule,omitempty"` // A NAT rule.
ExternalIP string `xml:"ExternalIp,omitempty"` // External IP address for rule.
}
// NatRule represents a NAT rule.
// Type: NatRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents a NAT rule.
// Since: 0.9
type NatRule struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
Description string `xml:"Description,omitempty"` // A description of the rule.
RuleType string `xml:"RuleType,omitempty"` // Type of NAT rule. One of: SNAT (source NAT), DNAT (destination NAT)
IsEnabled bool `xml:"IsEnabled"` // Used to enable or disable the firewall rule. Default value is true.
ID string `xml:"Id,omitempty"` // Firewall rule identifier.
GatewayNatRule *GatewayNatRule `xml:"GatewayNatRule,omitempty"` // Defines SNAT and DNAT types.
OneToOneBasicRule *NatOneToOneBasicRule `xml:"OneToOneBasicRule,omitempty"` // Maps one internal IP address to one external IP address.
OneToOneVMRule *NatOneToOneVMRule `xml:"OneToOneVmRule,omitempty"` // Maps one VM NIC to one external IP addresses.
PortForwardingRule *NatPortForwardingRule `xml:"PortForwardingRule,omitempty"` // Port forwarding internal to external IP addresses.
VMRule *NatVMRule `xml:"VmRule,omitempty"` // Port forwarding VM NIC to external IP addresses.
}
// GatewayNatRule represents the SNAT and DNAT rules.
// Type: GatewayNatRuleType represents the SNAT and DNAT rules.
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the SNAT and DNAT rules.
// Since: 5.1
type GatewayNatRule struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
Interface *Reference `xml:"Interface,omitempty"` // Interface to which rule is applied.
OriginalIP string `xml:"OriginalIp"` // Original IP for rule.
OriginalPort string `xml:"OriginalPort,omitempty"` // Original port for rule.
TranslatedIP string `xml:"TranslatedIp"` // Translated IP for rule.
TranslatedPort string `xml:"TranslatedPort,omitempty"` // Translated port for rule.
Protocol string `xml:"Protocol,omitempty"` // Protocol for rule.
IcmpSubType string `xml:"IcmpSubType,omitempty"` // ICMP subtype. One of: address-mask-request, address-mask-reply, destination-unreachable, echo-request, echo-reply, parameter-problem, redirect, router-advertisement, router-solicitation, source-quench, time-exceeded, timestamp-request, timestamp-reply, any.
}
// NatOneToOneBasicRule represents the NAT basic rule for one to one mapping of internal and external IP addresses from a network.
// Type: NatOneToOneBasicRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the NAT basic rule for one to one mapping of internal and external IP addresses from a network.
// Since: 0.9
type NatOneToOneBasicRule struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
MappingMode string `xml:"MappingMode"` // One of: automatic (map IP addresses automatically), manual (map IP addresses manually using ExternalIpAddress and InternalIpAddress)
ExternalIPAddress string `xml:"ExternalIpAddress"` // External IP address to map.
InternalIPAddress string `xml:"InternalIpAddress"` // Internal IP address to map.
}
// NatOneToOneVMRule represents the NAT rule for one to one mapping of VM NIC and external IP addresses from a network.
// Type: NatOneToOneVmRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the NAT rule for one to one mapping of VM NIC and external IP addresses from a network.
// Since: 0.9
type NatOneToOneVMRule struct {
Xmlns string `xml:"xmlns,attr,omitempty"`
// Elements
MappingMode string `xml:"MappingMode"` // Mapping mode.
ExternalIPAddress string `xml:"ExternalIpAddress"` // External IP address to map.
VAppScopedVMID string `xml:"VAppScopedVmId"` // VAppScopedVmId of VM to which this rule applies.
VMNicID int `xml:"VmNicId"` // VM NIC ID to which this rule applies.
}
// NatPortForwardingRule represents the NAT rule for port forwarding between internal IP/port and external IP/port.
// Type: NatPortForwardingRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the NAT rule for port forwarding between internal IP/port and external IP/port.
// Since: 0.9
type NatPortForwardingRule struct {
ExternalIPAddress string `xml:"ExternalIpAddress"` // External IP address to map.
ExternalPort int `xml:"ExternalPort"` // External port to forward to.
InternalIPAddress string `xml:"InternalIpAddress"` // Internal IP address to map.
InternalPort int `xml:"InternalPort"` // Internal port to forward to.
Protocol string `xml:"Protocol,omitempty"` // Protocol to forward. One of: TCP (forward TCP packets), UDP (forward UDP packets), TCP_UDP (forward TCP and UDP packets).
}
// NatVMRule represents the NAT rule for port forwarding between VM NIC/port and external IP/port.
// Type: NatVmRuleType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Represents the NAT rule for port forwarding between VM NIC/port and external IP/port.
// Since: 0.9
type NatVMRule struct {
ExternalIPAddress string `xml:"ExternalIpAddress,omitempty"` // External IP address to map.
ExternalPort int `xml:"ExternalPort"` // External port to forward to.
VAppScopedVMID string `xml:"VAppScopedVmId"` // VAppScopedVmId of VM to which this rule applies.
VMNicID int `xml:"VmNicId"` // VM NIC ID to which this rule applies.
InternalPort int `xml:"InternalPort"` // Internal port to forward to.
Protocol string `xml:"Protocol,omitempty"` // Protocol to forward. One of: TCP (forward TCP packets), UDP (forward UDP packets), TCP_UDP (forward TCP and UDP packets).
}
// QueryResultEdgeGatewayRecordsType is a container for query results in records format.
// Type: QueryResultRecordsType
// Namespace: http://www.vmware.com/vcloud/v1.5
// Description: Container for query results in records format.
// Since: 1.5
type QueryResultEdgeGatewayRecordsType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
Name string `xml:"name,attr,omitempty"` // The name of the entity.
Page int `xml:"page,attr,omitempty"` // Page of the result set that this container holds. The first page is page number 1.
PageSize int `xml:"pageSize,attr,omitempty"` // Page size, as a number of records or references.
Total float64 `xml:"total,attr,omitempty"` // Total number of records or references in the container.
// Elements
Link LinkList `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
EdgeGatewayRecord *QueryResultEdgeGatewayRecordType `xml:"EdgeGatewayRecord"` // A record representing a query result.
}
type QueryResultRecordsType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
Name string `xml:"name,attr,omitempty"` // The name of the entity.
Page int `xml:"page,attr,omitempty"` // Page of the result set that this container holds. The first page is page number 1.
PageSize int `xml:"pageSize,attr,omitempty"` // Page size, as a number of records or references.
Total float64 `xml:"total,attr,omitempty"` // Total number of records or references in the container.
// Elements
Link []*Link `xml:"Link,omitempty"` // A reference to an entity or operation associated with this object.
EdgeGatewayRecord *QueryResultEdgeGatewayRecordType `xml:"EdgeGatewayRecord"` // A record representing a query result.
VMRecord []*QueryResultVMRecordType `xml:"VMRecord"` // A record representing a VM result.
VAppRecord []*QueryResultVAppRecordType `xml:"VAppRecord"` // A record representing a VApp result.
OrgVdcStorageProfileRecord []*QueryResultOrgVdcStorageProfileRecordType `xml:"OrgVdcStorageProfileRecord"` // A record representing storage profiles
}
// QueryResultEdgeGatewayRecordType represents an edge gateway record as query result.
type QueryResultEdgeGatewayRecordType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Type string `xml:"type,attr,omitempty"` // The MIME type of the entity.
Name string `xml:"name,attr,omitempty"` // EdgeGateway name.
Vdc string `xml:"vdc,attr,omitempty"` // VDC Reference or ID
NumberOfExtNetworks int `xml:"numberOfExtNetworks,attr,omitempty"` // Number of external networks connected to the edgeGateway. Yes Yes
NumberOfOrgNetworks int `xml:"numberOfOrgNetworks,attr,omitempty"` // Number of org VDC networks connected to the edgeGateway Yes Yes
IsBusy bool `xml:"isBusy,attr"` // True if this Edge Gateway is busy. Yes Yes
GatewayStatus string `xml:"gatewayStatus,attr,omitempty"` //
HaStatus string `xml:"haStatus,attr,omitempty"` // High Availability Status of the edgeGateway Yes Yes
}
// QueryResultVMRecordType represents a VM record as query result.
type QueryResultVMRecordType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Name string `xml:"name,attr,omitempty"` // VM name.
Deployed bool `xml:"isDeployed,attr,omitempty"` // True if the virtual machine is deployed.
Status string `xml:"status,attr,omitempty"`
Busy bool `xml:"isBusy,attr,omitempty"`
Deleted bool `xml:"isDeleted,attr,omitempty"`
MaintenanceMode bool `xml:"isInMaintenanceMode,attr,omitempty"`
Published bool `xml:"isPublished,attr,omitempty"`
VAppTemplate bool `xml:"isVAppTemplate,attr,omitempty"`
VdcEnabled bool `xml:"isVdcEnabled,attr,omitempty"`
VdcHREF string `xml:"vdc,attr,omitempty"`
VAppParentHREF string `xml:"container,attr,omitempty"`
VAppParentName string `xml:"containerName,attr,omitempty"`
HardwareVersion int `xml:"hardwareVersion,attr,omitempty"`
HighestSupportedVersion int `xml:"pvdcHighestSupportedHardwareVersion,attr,omitempty"`
VmToolsVersion string `xml:"vmToolsVersion,attr,omitempty"`
GuestOS string `xml:"guestOs,attr,omitempty"`
MemoryMB int `xml:"memoryMB,attr,omitempty"`
Cpus int `xml:"numberOfCpus,attr,omitempty"`
StorageProfileName string `xml:"storageProfileName,attr,omitempty"`
NetworkName string `xml:"networkName,attr,omitempty"`
TaskHREF string `xml:"task,attr,omitempty"`
TaskStatusName string `xml:"taskStatusName,attr,omitempty"`
TaskDetails string `xml:"taskDetails,attr,omitempty"`
TaskStatus string `xml:"TaskStatus,attr,omitempty"`
}
// QueryResultVAppRecordType represents a VM record as query result.
type QueryResultVAppRecordType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Name string `xml:"name,attr"` // The name of the entity.
CreationDate string `xml:"creationDate,attr,omitempty"` // Creation date/time of the vApp.
Busy bool `xml:"isBusy,attr,omitempty"`
Deployed bool `xml:"isDeployed,attr,omitempty"` // True if the vApp is deployed.
Enabled bool `xml:"isEnabled,attr,omitempty"`
Expired bool `xml:"isExpired,attr,omitempty"`
MaintenanceMode bool `xml:"isInMaintenanceMode,attr,omitempty"`
Public bool `xml:"isPublic,attr,omitempty"`
OwnerName string `xml:"ownerName,attr,omitempty"`
Status string `xml:"status,attr,omitempty"`
VdcHREF string `xml:"vdc,attr,omitempty"`
VdcName string `xml:"vdcName,attr,omitempty"`
NumberOfVMs int `xml:"numberOfVMs,attr,omitempty"`
NumberOfCPUs int `xml:"numberOfCpus,attr,omitempty"`
CpuAllocationMhz int `xml:"cpuAllocationMhz,attr,omitempty"`
CpuAllocationInMhz int `xml:"cpuAllocationInMhz,attr,omitempty"`
StorageKB int `xml:"storageKB,attr,omitempty"`
MemoryAllocationMB int `xml:"memoryAllocationMB,attr,omitempty"`
AutoDeleteNotified bool `xml:"isAutoDeleteNotified,attr,omitempty"`
AutoUndeployNotified bool `xml:"isAutoUndeployNotified,attr,omitempty"`
VdcEnabled bool `xml:"isVdcEnabled, attr,omitempty"`
HonorBootOrder bool `xml:"honorBookOrder,attr,omitempty"`
HighestSupportedVersion int `xml:"pvdcHighestSupportedHardwareVersion,attr,omitempty"`
LowestHardwareVersion int `xml:"lowestHardwareVersionInVApp,attr,omitempty"`
TaskHREF string `xml:"task,attr,omitempty"`
TaskStatusName string `xml:"taskStatusName,attr,omitempty"`
TaskStatus string `xml:"TaskStatus,attr,omitempty"`
TaskDetails string `xml:"taskDetails,attr,omitempty"`
}
// QueryResultOrgVdcStorageProfileRecordType represents a storage
// profile as query result.
type QueryResultOrgVdcStorageProfileRecordType struct {
// Attributes
HREF string `xml:"href,attr,omitempty"` // The URI of the entity.
Name string `xml:"name,attr,omitempty"` // Storage Profile name.
VdcHREF string `xml:"vdc,attr,omitempty"`
VdcName string `xml:"vdcName,attr,omitempty"`
IsDefaultStorageProfile bool `xml:"isDefaultStorageProfile,attr,omitempty"`
IsEnabled bool `xml:"isEnabled,attr,omitempty"`
IsVdcBusy bool `xml:"isVdcBusy,attr,omitempty"`
NumberOfConditions int `xml:"numberOfConditions,attr,omitempty"`
StorageUsedMB int `xml:"storageUsedMB,attr,omitempty"`
StorageLimitMB int `xml:"storageLimitMB,attr,omitempty"`
}