Documentation ¶
Index ¶
- Variables
- type AdminOrg
- type AdminVDC
- type BMS
- type BMSDetail
- type BMSNetwork
- type BMSStorage
- type BMSStorageDetail
- type Bandwidth
- type CAVAdminVDC
- type CAVVdc
- func (v *CAVVdc) GetVDC(vdcName string) (*VDC, error)
- func (v *CAVVdc) GetVDCGroup(vdcGroupName string) (*VDCGroup, error)
- func (v *CAVVdc) GetVDCOrVDCGroup(vdcOrVDCGroupName string) (VDCOrVDCGroupInterface, error)
- func (v *CAVVdc) List() (*infrapi.VDCs, error)
- func (v *CAVVdc) New(ctx context.Context, object *infrapi.CAVVirtualDataCenter) (*VDC, error)
- type ClassService
- type EdgeClient
- type EdgeGateway
- func (v *EdgeGateway) Get(edgeGatewayNameOrID string) (edgeClient *EdgeClient, err error)
- func (v *EdgeGateway) GetAllowedBandwidthValues(t0VrfName string) (allowedValues []int, err error)
- func (v *EdgeGateway) GetByID(edgeGatewayID string) (edgeClient *EdgeClient, err error)deprecated
- func (v *EdgeGateway) GetByName(edgeGatewayName string) (edgeClient *EdgeClient, err error)deprecated
- func (v *EdgeGateway) List() (response *EdgeGateways, err error)
- func (v *EdgeGateway) New(vdcName, tier0VrfName string) (job *commoncloudavenue.JobStatus, err error)
- func (v *EdgeGateway) NewFromVDCGroup(vdcGroupName, tier0VrfName string) (job *commoncloudavenue.JobStatus, err error)
- type EdgeGatewayFirewall
- type EdgeGatewayType
- func (e *EdgeGatewayType) Delete() (job *commoncloudavenue.JobStatus, err error)
- func (e *EdgeGatewayType) GetBandwidth() Bandwidth
- func (e *EdgeGatewayType) GetDescription() string
- func (e *EdgeGatewayType) GetID() string
- func (e *EdgeGatewayType) GetName() string
- func (e *EdgeGatewayType) GetOwnerName() string
- func (e *EdgeGatewayType) GetOwnerType() OwnerType
- func (e *EdgeGatewayType) GetT0() string
- func (e *EdgeGatewayType) GetTier0VrfID() string
- func (e *EdgeGatewayType) ListNetworksType() (response *NetworkTypes, err error)
- func (e *EdgeGatewayType) UpdateBandwidth(rateLimit int) (job *commoncloudavenue.JobStatus, err error)
- type EdgeGateways
- type EdgeVCDInterface
- type Get
- func (q *Get) EdgeGW(edgeGWName string) (*types.QueryResultEdgeGatewayRecordType, error)
- func (q *Get) VAPP(vappName string) (*types.QueryResultVAppRecordType, error)
- func (q *Get) VDC(vdcName string) (*types.QueryResultOrgVdcRecordType, error)
- func (q *Get) VM(vmName, vAppName string) (*types.QueryResultVMRecordType, error)
- type IP
- type IPs
- type List
- type NetworkType
- type NetworkTypes
- type OSEError
- type OSEErrorStatus
- type Org
- func (o *Org) DeleteNetworkDHCP(orgNetworkID string) error
- func (o *Org) GetID() string
- func (o *Org) GetName() string
- func (o *Org) GetNetworkDHCP(orgNetworkID string) (*govcd.OpenApiOrgVdcNetworkDhcp, error)
- func (o *Org) UpdateNetworkDHCP(orgNetworkID string, dhcpParameters *govcdtypes.OpenApiOrgVdcNetworkDhcp) error
- type OwnerType
- type PublicIP
- func (v *PublicIP) GetIP(publicIP string) (response *IP, err error)
- func (v *PublicIP) GetIPByJob(job *commoncloudavenue.JobStatus) (response *IP, err error)
- func (v *PublicIP) GetIPs() (response *IPs, err error)
- func (v *PublicIP) GetIPsByEdgeGateway(edgeGatewayName string) (response *IPs, err error)
- func (v *PublicIP) New(edgeGatewayName string) (job *commoncloudavenue.JobStatus, err error)
- type Query
- type S3Client
- type S3Credential
- func (c *S3Credential) Delete() (err error)
- func (c *S3Credential) GetAccessKey() string
- func (c *S3Credential) GetAllowedBuckets() []string
- func (c *S3Credential) GetAppName() string
- func (c *S3Credential) GetCreatedDate() time.Time
- func (c *S3Credential) GetLastAccessDate() time.Time
- func (c *S3Credential) GetOwner() string
- func (c *S3Credential) GetOwnerID() string
- func (c *S3Credential) GetSecretKey() string
- func (c *S3Credential) GetStorageTenantID() string
- func (c *S3Credential) GetStorageUserID() string
- func (c *S3Credential) GetTenantID() string
- func (c *S3Credential) GetType() string
- func (c *S3Credential) GetUsedK8SClusters() []string
- func (c *S3Credential) IsActive() bool
- func (c *S3Credential) IsImmutable() bool
- func (c *S3Credential) IsProviderOwner() bool
- type S3Credentials
- type S3User
- func (s *S3User) GetAvailableBytes() int
- func (s *S3User) GetBucketCount() int
- func (s *S3User) GetCanonicalID() (resp string, err error)
- func (s *S3User) GetCredential(accessKey string) (resp *S3Credential, err error)
- func (s *S3User) GetCredentials() (resp *S3Credentials, err error)
- func (s *S3User) GetCurrentRegion() string
- func (s *S3User) GetExistedOnStorage() bool
- func (s *S3User) GetFullName() string
- func (s *S3User) GetID() string
- func (s *S3User) GetName() string
- func (s *S3User) GetObjectCount() int
- func (s *S3User) GetPolicyArns() []string
- func (s *S3User) GetRole() string
- func (s *S3User) GetSiteID() string
- func (s *S3User) GetSiteName() string
- func (s *S3User) GetSiteRestEndpoint() string
- func (s *S3User) GetSourceTenant() string
- func (s *S3User) GetSubordinateRoles() []string
- func (s *S3User) GetTotalBytes() int
- func (s *S3User) GetUsageScope() string
- func (s *S3User) GetUsedBytes() int
- func (s *S3User) IsActive() bool
- func (s *S3User) IsPoseAsUser() bool
- func (s *S3User) IsRemote() bool
- func (s *S3User) NewCredential() (resp *S3Credential, err error)
- type S3Users
- type SyncBucketResponse
- type T0
- type T0Service
- type T0Services
- type T0s
- type Tier0
- type TypeOfNetwork
- type V1
- type VAPP
- func (v VAPP) GetDeploymentLeaseInSeconds() int
- func (v VAPP) GetDescription() string
- func (v VAPP) GetHREF() string
- func (v VAPP) GetID() string
- func (v VAPP) GetName() string
- func (v VAPP) GetStatusCode() int
- func (v VAPP) GetStorageLeaseInSeconds() int
- func (v VAPP) IsVAPPNetwork(networkName string) (bool, error)
- func (v VAPP) IsVAPPOrgNetwork(networkName string) (bool, error)
- type VCDA
- type VDC
- func (v *VDC) AddStorageProfile(storageProfile infrapi.StorageProfile)
- func (v VDC) CreateVAPP(name, description string) (*VAPP, error)
- func (v *VDC) Delete(ctx context.Context) (err error)
- func (v *VDC) GetBillingModel() infrapi.BillingModel
- func (v *VDC) GetCPUAllocated() int
- func (v VDC) GetDefaultPlacementPolicyID() string
- func (v *VDC) GetDescription() string
- func (v *VDC) GetDisponibilityClass() infrapi.DisponibilityClass
- func (v *VDC) GetID() string
- func (v VDC) GetIPSetByID(id string) (*govcd.NsxtFirewallGroup, error)
- func (v VDC) GetIPSetByName(name string) (*govcd.NsxtFirewallGroup, error)
- func (v VDC) GetIPSetByNameOrID(nameOrID string) (*govcd.NsxtFirewallGroup, error)
- func (v *VDC) GetMemoryAllocated() int
- func (v *VDC) GetName() string
- func (v VDC) GetSecurityGroupByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)
- func (v VDC) GetSecurityGroupByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)
- func (v VDC) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
- func (v *VDC) GetServiceClass() infrapi.ServiceClass
- func (v *VDC) GetStorageBillingModel() infrapi.BillingModel
- func (v *VDC) GetStorageProfiles() []infrapi.StorageProfile
- func (v VDC) GetVAPP(nameOrID string, refresh bool) (*VAPP, error)
- func (v *VDC) GetVCPUInMhz() int
- func (v VDC) IsVDCGroup() bool
- func (v *VDC) IsValid(isUpdate bool) error
- func (v *VDC) RemoveStorageProfile(storageProfileName infrapi.StorageProfile)
- func (v *VDC) Set(vdc *infrapi.CAVVirtualDataCenter)
- func (v *VDC) SetCPUAllocated(cpuAllocated int)
- func (v *VDC) SetDescription(description string)
- func (v VDC) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)
- func (v *VDC) SetMemoryAllocated(memoryAllocated int)
- func (v *VDC) SetName(name string) error
- func (v *VDC) SetStorageProfiles(storageProfiles []infrapi.StorageProfile)
- func (v *VDC) SetVCPUInMhz(vcpuInMhz int)
- func (v *VDC) Update(ctx context.Context) (err error)
- func (v *VDC) Vmware() *govcd.Vdc
- type VDCAIP
- type VDCAIps
- type VDCGroup
- func (g VDCGroup) GetDescription() string
- func (g VDCGroup) GetID() string
- func (g VDCGroup) GetIPSetByID(id string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) GetIPSetByName(name string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) GetIPSetByNameOrID(nameOrID string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) GetName() string
- func (g VDCGroup) GetSecurityGroupByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) GetSecurityGroupByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
- func (g VDCGroup) IsVDCGroup() bool
- func (g VDCGroup) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)
- type VDCOrVDCGroupInterface
Constants ¶
This section is empty.
Variables ¶
var ( ErrEmptyVDCNameProvided = fmt.Errorf("empty VDC name provided") ErrRetrievingOrg = fmt.Errorf("error retrieving org") ErrRetrievingOrgAdmin = fmt.Errorf("error retrieving org admin") ErrRetrievingVDC = fmt.Errorf("error retrieving VDC") ErrRetrievingVDCOrVDCGroup = fmt.Errorf("error retrieving VDC or VDC Group") )
! Errors
Functions ¶
This section is empty.
Types ¶
type AdminOrg ¶ added in v0.12.7
func (*AdminOrg) GetOrgVAppLeaseSettings ¶ added in v0.12.7
func (ao *AdminOrg) GetOrgVAppLeaseSettings() *govcdtypes.VAppLeaseSettings
GetOrgVAppLeaseSettings retrieves the lease settings for a vApp in the specified organization.
func (*AdminOrg) ListCatalogs ¶ added in v0.12.7
func (ao *AdminOrg) ListCatalogs() *govcdtypes.CatalogsList
ListCatalogs
Get the catalogs list from the admin org.
type BMS ¶ added in v0.12.0
type BMS struct { BMSNetworks []BMSNetwork `json:"network"` BMSDetails []BMSDetail `json:"bms"` }
func (*BMS) GetBMSByHostname ¶ added in v0.12.1
func (*BMS) GetNetworks ¶ added in v0.12.0
func (v *BMS) GetNetworks() []BMSNetwork
type BMSDetail ¶ added in v0.12.0
type BMSDetail struct { BMSType string `json:"bmsType"` Hostname string `json:"hostname"` OS string `json:"os"` BiosConfiguration string `json:"biosConfiguration"` Storages BMSStorage `json:"storage"` }
func (*BMSDetail) GetStorages ¶ added in v0.12.0
func (v *BMSDetail) GetStorages() BMSStorage
type BMSNetwork ¶ added in v0.12.0
type BMSNetwork struct { VLANID string `json:"vlanid"` Subnet string `json:"subnet"` Prefix string `json:"prefix"` }
func (*BMSNetwork) GetPrefix ¶ added in v0.12.0
func (v *BMSNetwork) GetPrefix() string
func (*BMSNetwork) GetSubnet ¶ added in v0.12.0
func (v *BMSNetwork) GetSubnet() string
func (*BMSNetwork) GetVLANID ¶ added in v0.12.0
func (v *BMSNetwork) GetVLANID() string
type BMSStorage ¶ added in v0.12.0
type BMSStorage struct { Local []BMSStorageDetail `json:"local,omitempty"` System []BMSStorageDetail `json:"system,omitempty"` Data []BMSStorageDetail `json:"data,omitempty"` }
func (*BMSStorage) GetData ¶ added in v0.12.0
func (v *BMSStorage) GetData() []BMSStorageDetail
func (*BMSStorage) GetLocal ¶ added in v0.12.0
func (v *BMSStorage) GetLocal() []BMSStorageDetail
func (*BMSStorage) GetShared ¶ added in v0.12.0
func (v *BMSStorage) GetShared() []BMSStorageDetail
func (*BMSStorage) GetSystem ¶ added in v0.12.0
func (v *BMSStorage) GetSystem() []BMSStorageDetail
type BMSStorageDetail ¶ added in v0.12.0
type BMSStorageDetail struct { StorageClass string `json:"storageClass"` Size string `json:"size"` }
func (*BMSStorageDetail) GetSize ¶ added in v0.12.0
func (v *BMSStorageDetail) GetSize() string
func (*BMSStorageDetail) GetStorageClass ¶ added in v0.12.0
func (v *BMSStorageDetail) GetStorageClass() string
type CAVAdminVDC ¶ added in v0.12.7
type CAVAdminVDC struct{}
type CAVVdc ¶ added in v0.6.0
type CAVVdc struct{}
func (*CAVVdc) GetVDC ¶ added in v0.6.0
Get retrieves the VDC (Virtual Data Center) by its name. It returns a pointer to the VDC and an error if any. The function performs concurrent requests to retrieve the VDC from both the VMware and the infrapi. It uses goroutines and channels to handle the concurrent requests and waits for all goroutines to finish using a WaitGroup. The function returns the VDC that was successfully retrieved from either the VMware or the infrapi.
func (*CAVVdc) GetVDCGroup ¶ added in v0.6.0
GetVDCGroup retrieves the VDC Group by its name. It returns a pointer to the VDC Group and an error if any.
func (*CAVVdc) GetVDCOrVDCGroup ¶ added in v0.6.0
func (v *CAVVdc) GetVDCOrVDCGroup(vdcOrVDCGroupName string) (VDCOrVDCGroupInterface, error)
GetVDCOrVDCGroup returns the VDC or VDC Group by its name. It returns a pointer to the VDC or VDC Group and an error if any.
type ClassService ¶
type ClassService string
const ( // ClassServiceVRFStandard - VRF Standard ClassServiceVRFStandard ClassService = "VRF_STANDARD" // ClassServiceVRFPremium - VRF Premium ClassServiceVRFPremium ClassService = "VRF_PREMIUM" // ClassServiceVRFDedicatedMedium - VRF Dedicated Medium ClassServiceVRFDedicatedMedium ClassService = "VRF_DEDICATED_MEDIUM" // ClassServiceVRFDedicatedLarge - VRF Dedicated Large ClassServiceVRFDedicatedLarge ClassService = "VRF_DEDICATED_LARGE" )
func (ClassService) IsVRFDedicatedLarge ¶ added in v0.10.0
func (c ClassService) IsVRFDedicatedLarge() bool
IsVRFDedicatedLarge - Returns true if the ClassService is VRFDedicatedLarge
func (ClassService) IsVRFDedicatedMedium ¶ added in v0.10.0
func (c ClassService) IsVRFDedicatedMedium() bool
IsVRFDedicatedMedium - Returns true if the ClassService is VRFDedicatedMedium
func (ClassService) IsVRFPremium ¶
func (c ClassService) IsVRFPremium() bool
IsVRFPremium - Returns true if the ClassService is VRFPremium
func (ClassService) IsVRFStandard ¶
func (c ClassService) IsVRFStandard() bool
IsVRFStandard - Returns true if the ClassService is VRFStandard
type EdgeClient ¶ added in v0.13.0
type EdgeClient struct { EdgeVCDInterface *EdgeGatewayType }
func (*EdgeClient) GetFirewall ¶ added in v0.13.0
func (e *EdgeClient) GetFirewall() (*EdgeGatewayFirewall, error)
GetFirewall retrieves the firewall configuration for the Edge Gateway. It first fetches the VMware Edge Gateway associated with the EdgeGw instance, and then retrieves the firewall configuration from the Edge Gateway. Returns an EdgeGatewayFirewall instance containing the firewall configuration, or an error if any step in the process fails.
func (*EdgeClient) GetVmwareEdgeGateway ¶ added in v0.13.0
func (e *EdgeClient) GetVmwareEdgeGateway() (*govcd.NsxtEdgeGateway, error)
GetVmwareEdgeGateway - Returns the VMware Edge Gateway
type EdgeGateway ¶
type EdgeGateway struct{}
func (*EdgeGateway) Get ¶ added in v0.13.0
func (v *EdgeGateway) Get(edgeGatewayNameOrID string) (edgeClient *EdgeClient, err error)
func (*EdgeGateway) GetAllowedBandwidthValues ¶
func (v *EdgeGateway) GetAllowedBandwidthValues(t0VrfName string) (allowedValues []int, err error)
GetAllowedBandwidthValues - Returns the allowed rate limit value
func (*EdgeGateway) GetByID
deprecated
func (v *EdgeGateway) GetByID(edgeGatewayID string) (edgeClient *EdgeClient, err error)
GetByID - Returns the edge gateway ID ID format is UUID
Deprecated: Use Get instead
func (*EdgeGateway) GetByName
deprecated
func (v *EdgeGateway) GetByName(edgeGatewayName string) (edgeClient *EdgeClient, err error)
Get - Returns the edge gateway
Deprecated: Use Get instead
func (*EdgeGateway) List ¶
func (v *EdgeGateway) List() (response *EdgeGateways, err error)
List - Returns the list of edge gateways
func (*EdgeGateway) New ¶
func (v *EdgeGateway) New(vdcName, tier0VrfName string) (job *commoncloudavenue.JobStatus, err error)
New - Creates a new edge gateway
func (*EdgeGateway) NewFromVDCGroup ¶
func (v *EdgeGateway) NewFromVDCGroup(vdcGroupName, tier0VrfName string) (job *commoncloudavenue.JobStatus, err error)
NewFromVDCGroup - Creates a new edge gateway from a VDC Group
type EdgeGatewayFirewall ¶ added in v0.13.0
type EdgeGatewayFirewall struct { *govcd.NsxtFirewall // contains filtered or unexported fields }
func (*EdgeGatewayFirewall) DeleteFirewall ¶ added in v0.13.0
func (e *EdgeGatewayFirewall) DeleteFirewall() error
DeleteFirewall deletes the firewall configuration for the Edge Gateway.
func (*EdgeGatewayFirewall) UpdateFirewall ¶ added in v0.13.0
func (e *EdgeGatewayFirewall) UpdateFirewall(fwRules []*govcdtypes.NsxtFirewallRule) (err error)
UpdateFirewall updates the firewall configuration for the Edge Gateway. It first fetches the VMware Edge Gateway associated with the EdgeGw instance, and then updates the firewall configuration on the Edge Gateway. Returns an error if any step in the process fails.
type EdgeGatewayType ¶ added in v0.13.0
type EdgeGatewayType struct { Tier0VrfName string `json:"tier0VrfId"` EdgeID string `json:"edgeId"` EdgeName string `json:"edgeName"` OwnerType OwnerType `json:"ownerType"` OwnerName string `json:"ownerName"` Description string `json:"description"` Bandwidth Bandwidth `json:"rateLimit"` }
func (*EdgeGatewayType) Delete ¶ added in v0.13.0
func (e *EdgeGatewayType) Delete() (job *commoncloudavenue.JobStatus, err error)
Delete - Deletes the edge gateway
func (*EdgeGatewayType) GetBandwidth ¶ added in v0.13.0
func (e *EdgeGatewayType) GetBandwidth() Bandwidth
GetBandwidth - Returns the rate limit
func (*EdgeGatewayType) GetDescription ¶ added in v0.13.0
func (e *EdgeGatewayType) GetDescription() string
GetDescription - Returns the Description
func (*EdgeGatewayType) GetID ¶ added in v0.13.0
func (e *EdgeGatewayType) GetID() string
GetID - Returns the EdgeID
func (*EdgeGatewayType) GetName ¶ added in v0.13.0
func (e *EdgeGatewayType) GetName() string
GetName - Returns the EdgeName
func (*EdgeGatewayType) GetOwnerName ¶ added in v0.13.0
func (e *EdgeGatewayType) GetOwnerName() string
GetOwnerName - Returns the OwnerName
func (*EdgeGatewayType) GetOwnerType ¶ added in v0.13.0
func (e *EdgeGatewayType) GetOwnerType() OwnerType
GetOwnerType - Returns the OwnerType
func (*EdgeGatewayType) GetT0 ¶ added in v0.13.0
func (e *EdgeGatewayType) GetT0() string
GetT0 - Returns the Tier0VrfID (alias)
func (*EdgeGatewayType) GetTier0VrfID ¶ added in v0.13.0
func (e *EdgeGatewayType) GetTier0VrfID() string
GetTier0VrfID - Returns the Tier0VrfID
func (*EdgeGatewayType) ListNetworksType ¶ added in v0.13.0
func (e *EdgeGatewayType) ListNetworksType() (response *NetworkTypes, err error)
ListNetworksType - Returns the list of networks by type configured on the edge gateway
func (*EdgeGatewayType) UpdateBandwidth ¶ added in v0.13.0
func (e *EdgeGatewayType) UpdateBandwidth(rateLimit int) (job *commoncloudavenue.JobStatus, err error)
UpdateBandwidth - Updates the bandwidth
type EdgeGateways ¶
type EdgeGateways []EdgeGatewayType
func (*EdgeGateways) GetBandwidthCapacityRemaining ¶
func (e *EdgeGateways) GetBandwidthCapacityRemaining(t0VrfName string) (response int, err error)
GetBandwidthCapacityRemaining - Returns the bandwidth capacity remaining in Mbps
type EdgeVCDInterface ¶ added in v0.13.0
type EdgeVCDInterface interface { GetNsxtFirewall() (*govcd.NsxtFirewall, error) UpdateNsxtFirewall(firewallRules *govcdtypes.NsxtFirewallRuleContainer) (*govcd.NsxtFirewall, error) }
This interface contains all methods for the edge gateway in the CloudAvenue environment.
type Get ¶ added in v0.7.0
type Get struct{}
type IP ¶
type IP struct { UplinkIP string `json:"uplinkIp"` TranslatedIP string `json:"translatedIp"` EdgeGatewayName string `json:"edgeGatewayName"` }
type List ¶ added in v0.7.0
type List struct{}
type NetworkType ¶
type NetworkType struct { Type TypeOfNetwork `json:"networkType"` PrefixLength int `json:"prefixLength"` StartAddress string `json:"startAddress"` }
func (NetworkType) GetEndAddress ¶
func (n NetworkType) GetEndAddress() string
GetEndAddress - Returns the EndAddress
func (NetworkType) GetPrefixLength ¶
func (n NetworkType) GetPrefixLength() int
GetPrefixLength - Returns the PrefixLength
func (NetworkType) GetStartAddress ¶
func (n NetworkType) GetStartAddress() string
GetStartAddress - Returns the StartAddress
func (NetworkType) IsServiceZone ¶
func (n NetworkType) IsServiceZone() bool
IsServiceZone - Returns true if the network type is ServiceZone
type NetworkTypes ¶
type NetworkTypes []NetworkType
type OSEError ¶ added in v0.5.1
type OSEError struct { Status OSEErrorStatus `json:"status"` Code string `json:"code"` Message string `json:"message"` }
func (*OSEError) GetMessage ¶ added in v0.5.1
func (*OSEError) GetStatus ¶ added in v0.5.1
func (e *OSEError) GetStatus() OSEErrorStatus
func (*OSEError) IsNotFountError ¶ added in v0.5.1
IsNotFountError returns true if the error is a 404 error
type OSEErrorStatus ¶ added in v0.5.1
type OSEErrorStatus int
type Org ¶
func (*Org) DeleteNetworkDHCP ¶ added in v0.12.7
DeleteNetworkDHCP deletes the DHCP object for the org network provided in parameter.
func (*Org) GetNetworkDHCP ¶ added in v0.12.7
func (o *Org) GetNetworkDHCP(orgNetworkID string) (*govcd.OpenApiOrgVdcNetworkDhcp, error)
TODO refacto GetNetworkDHCP returns the DHCP object for the org network provided in parameter.
func (*Org) UpdateNetworkDHCP ¶ added in v0.12.7
func (o *Org) UpdateNetworkDHCP(orgNetworkID string, dhcpParameters *govcdtypes.OpenApiOrgVdcNetworkDhcp) error
UpdateNetworkDHCP updates the DHCP object for the org network provided in parameter.
type OwnerType ¶
type OwnerType string
const (
OwnerVDC OwnerType = "vdc"
)
func (OwnerType) IsVDCGROUP ¶
IsVDCGROUP - Returns true if the owner type is VDCGROUP
type PublicIP ¶
type PublicIP struct{}
func (*PublicIP) GetIPByJob ¶ added in v0.7.1
func (v *PublicIP) GetIPByJob(job *commoncloudavenue.JobStatus) (response *IP, err error)
GetIPByJob - Returns the public IP by job
func (*PublicIP) GetIPsByEdgeGateway ¶
GetIPsByEdgeGateway - Returns the list of public IPs by edge gateway
type S3Client ¶ added in v0.4.0
func (S3Client) SyncBucket ¶ added in v0.4.1
SyncBucket - Syncs a bucket
type S3Credential ¶ added in v0.4.0
type S3Credential struct { TenantID string `json:"tenantId"` StorageTenantID string `json:"storageTenantId"` Owner string `json:"owner"` OwnerID string `json:"ownerId"` StorageUserID string `json:"storageUserId"` Type string `json:"type"` Immutable bool `json:"immutable"` AccessKey string `json:"accessKey"` SecretKey string `json:"secretKey"` Active bool `json:"active"` CreatedDate time.Time `json:"createdDate"` LastAccessDate time.Time `json:"lastAccessDate"` AppName string `json:"appName"` AllowedBuckets []string `json:"allowedBuckets"` UsedK8SClusters []string `json:"usedK8sClusters"` ProviderOwner bool `json:"providerOwner"` }
func (*S3Credential) Delete ¶ added in v0.4.0
func (c *S3Credential) Delete() (err error)
DeleteCredential - Delete a credential
func (*S3Credential) GetAccessKey ¶ added in v0.4.0
func (c *S3Credential) GetAccessKey() string
func (*S3Credential) GetAllowedBuckets ¶ added in v0.4.0
func (c *S3Credential) GetAllowedBuckets() []string
func (*S3Credential) GetAppName ¶ added in v0.4.0
func (c *S3Credential) GetAppName() string
func (*S3Credential) GetCreatedDate ¶ added in v0.4.0
func (c *S3Credential) GetCreatedDate() time.Time
func (*S3Credential) GetLastAccessDate ¶ added in v0.4.0
func (c *S3Credential) GetLastAccessDate() time.Time
func (*S3Credential) GetOwner ¶ added in v0.4.0
func (c *S3Credential) GetOwner() string
func (*S3Credential) GetOwnerID ¶ added in v0.4.0
func (c *S3Credential) GetOwnerID() string
func (*S3Credential) GetSecretKey ¶ added in v0.4.0
func (c *S3Credential) GetSecretKey() string
func (*S3Credential) GetStorageTenantID ¶ added in v0.4.0
func (c *S3Credential) GetStorageTenantID() string
func (*S3Credential) GetStorageUserID ¶ added in v0.4.0
func (c *S3Credential) GetStorageUserID() string
func (*S3Credential) GetTenantID ¶ added in v0.4.0
func (c *S3Credential) GetTenantID() string
func (*S3Credential) GetType ¶ added in v0.4.0
func (c *S3Credential) GetType() string
func (*S3Credential) GetUsedK8SClusters ¶ added in v0.4.0
func (c *S3Credential) GetUsedK8SClusters() []string
func (*S3Credential) IsActive ¶ added in v0.4.0
func (c *S3Credential) IsActive() bool
func (*S3Credential) IsImmutable ¶ added in v0.4.0
func (c *S3Credential) IsImmutable() bool
func (*S3Credential) IsProviderOwner ¶ added in v0.4.0
func (c *S3Credential) IsProviderOwner() bool
type S3Credentials ¶ added in v0.4.0
type S3Credentials []S3Credential
type S3User ¶ added in v0.4.0
type S3User struct { Name string `json:"name"` ID string `json:"id"` FullName string `json:"fullName"` Role string `json:"role"` SubordinateRoles []string `json:"subordinateRoles"` Active bool `json:"active"` CurrentRegion string `json:"currentRegion"` Site struct { ID string `json:"id"` Name string `json:"name"` RestEndpoint string `json:"restEndpoint"` } `json:"site"` Usage struct { Scope string `json:"scope"` TotalBytes int `json:"totalBytes"` UsedBytes int `json:"usedBytes"` AvailableBytes int `json:"availableBytes"` ObjectCount int `json:"objectCount"` BucketCount int `json:"bucketCount"` } `json:"usage"` ExistedOnStorage bool `json:"existedOnStorage"` CanoncialID string `json:"storageCanonicalId"` PolicyArns []string `json:"policyArns"` Remote bool `json:"remote"` PoseAsUser bool `json:"poseAsUser"` SourceTenant string `json:"sourceTenant"` }
func (*S3User) GetAvailableBytes ¶ added in v0.4.0
func (*S3User) GetBucketCount ¶ added in v0.4.0
func (*S3User) GetCanonicalID ¶ added in v0.4.0
GetCanonicalID - Get a S3 user canonical ID by username
func (*S3User) GetCredential ¶ added in v0.4.0
func (s *S3User) GetCredential(accessKey string) (resp *S3Credential, err error)
GetCredential - Get a credential by access key
func (*S3User) GetCredentials ¶ added in v0.4.0
func (s *S3User) GetCredentials() (resp *S3Credentials, err error)
GetCredentials - Get a list of credentials
func (*S3User) GetCurrentRegion ¶ added in v0.4.0
func (*S3User) GetExistedOnStorage ¶ added in v0.4.0
func (*S3User) GetFullName ¶ added in v0.4.0
func (*S3User) GetObjectCount ¶ added in v0.4.0
func (*S3User) GetPolicyArns ¶ added in v0.4.0
func (*S3User) GetSiteName ¶ added in v0.4.0
func (*S3User) GetSiteRestEndpoint ¶ added in v0.4.0
func (*S3User) GetSourceTenant ¶ added in v0.4.0
func (*S3User) GetSubordinateRoles ¶ added in v0.4.0
func (*S3User) GetTotalBytes ¶ added in v0.4.0
func (*S3User) GetUsageScope ¶ added in v0.4.0
func (*S3User) GetUsedBytes ¶ added in v0.4.0
func (*S3User) IsPoseAsUser ¶ added in v0.4.0
func (*S3User) NewCredential ¶ added in v0.4.0
func (s *S3User) NewCredential() (resp *S3Credential, err error)
NewCredential - Create a new credential
type SyncBucketResponse ¶ added in v0.4.1
type SyncBucketResponse struct { ID string `json:"id"` VcdID string `json:"vcdId"` VcdAssociationID string `json:"vcdAssociationId"` Description string `json:"description"` Status string `json:"status"` ResourceType string `json:"resourceType"` ResourceKey string `json:"resourceKey"` Progress int `json:"progress"` Tenant string `json:"tenant"` Owner string `json:"owner"` StartDate time.Time `json:"startDate"` EndDate time.Time `json:"endDate"` Reason string `json:"reason"` Metadata struct { AdditionalProp1 string `json:"additionalProp1"` AdditionalProp2 string `json:"additionalProp2"` AdditionalProp3 string `json:"additionalProp3"` } `json:"metadata"` }
type T0 ¶
type T0 struct { Tier0Vrf string `json:"tier0_vrf"` Tier0Provider string `json:"tier0_provider"` Tier0ClassService string `json:"tier0_class_service"` ClassService ClassService `json:"class_service"` Services T0Services `json:"services"` }
func (*T0) GetBandwidthCapacity ¶
GetBandwidthCapacity - Returns the Bandwidth Capacity of the T0 in Mbps
func (*T0) GetClassService ¶
func (t *T0) GetClassService() ClassService
GetClassService - Returns the ClassService
func (*T0) GetTier0ClassService ¶
GetTier0ClassService - Returns the Tier0ClassService
func (*T0) GetTier0Provider ¶
GetTier0Provider - Returns the Tier0Provider
type T0Service ¶
func (*T0Service) GetService ¶
GetService - Returns the Service
type T0Services ¶
type T0Services []T0Service
type TypeOfNetwork ¶
type TypeOfNetwork string
const (
NetworkTypeServiceZone TypeOfNetwork = "sv"
)
type V1 ¶
type V1 struct { Netbackup netbackup.Netbackup PublicIP PublicIP EdgeGateway EdgeGateway T0 Tier0 VCDA VCDA BMS BMS }
func (*V1) AdminVDC ¶ added in v0.12.7
func (v *V1) AdminVDC() *CAVAdminVDC
type VAPP ¶ added in v0.12.6
func (VAPP) GetDeploymentLeaseInSeconds ¶ added in v0.12.6
GetDeploymentLeaseInSeconds retrieves the lease duration in seconds for a deployment.
func (VAPP) GetDescription ¶ added in v0.12.6
GetDescription give you the status code of the vApp.
func (VAPP) GetStatusCode ¶ added in v0.12.6
GetStatusCode give you the status code of the vApp.
func (VAPP) GetStorageLeaseInSeconds ¶ added in v0.12.6
GetStorageLeaseInSeconds retrieves the lease duration in seconds for a storage resource.
func (VAPP) IsVAPPNetwork ¶ added in v0.12.6
IsVAPPNetwork check if it is a vApp network (not vApp Org Network).
type VCDA ¶
type VCDA struct{}
func (*VCDA) RegisterIP ¶ added in v0.5.0
RegisterIP - Registers a new IP to the list
type VDC ¶
func (*VDC) AddStorageProfile ¶ added in v0.6.0
func (v *VDC) AddStorageProfile(storageProfile infrapi.StorageProfile)
AddStorageProfile add a storage profile to the VDC.
func (VDC) CreateVAPP ¶ added in v0.12.6
CreateVAPP create new vApp.
func (*VDC) GetBillingModel ¶ added in v0.6.0
func (v *VDC) GetBillingModel() infrapi.BillingModel
GetBillingModel returns the billing model of the VDC.
func (*VDC) GetCPUAllocated ¶ added in v0.6.0
GetCPUAllocated returns the CPU allocated of the VDC.
func (VDC) GetDefaultPlacementPolicyID ¶ added in v0.12.6
GetDefaultPlacementPolicyID give you the ID of the default placement policy.
func (*VDC) GetDescription ¶ added in v0.6.0
GetDescription returns the description of the VDC.
func (*VDC) GetDisponibilityClass ¶ added in v0.6.0
func (v *VDC) GetDisponibilityClass() infrapi.DisponibilityClass
GetDisponibilityClass returns the disponibility class of the VDC.
func (VDC) GetIPSetByID ¶ added in v0.12.6
func (v VDC) GetIPSetByID(id string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByID return the NSX-T firewall group using the ID provided in the argument.
func (VDC) GetIPSetByName ¶ added in v0.12.6
func (v VDC) GetIPSetByName(name string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByName return the NSX-T firewall group using the name provided in the argument.
func (VDC) GetIPSetByNameOrID ¶ added in v0.12.6
func (v VDC) GetIPSetByNameOrID(nameOrID string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByNameOrId return the NSX-T firewall group using the name or ID provided in the argument.
func (*VDC) GetMemoryAllocated ¶ added in v0.6.0
GetMemoryAllocated returns the memory allocated of the VDC.
func (VDC) GetSecurityGroupByID ¶ added in v0.12.6
func (v VDC) GetSecurityGroupByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByID return the NSX-T security group using the ID provided in the argument.
func (VDC) GetSecurityGroupByName ¶ added in v0.12.6
func (v VDC) GetSecurityGroupByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByName return the NSX-T security group using the name provided in the argument.
func (VDC) GetSecurityGroupByNameOrID ¶ added in v0.12.6
func (v VDC) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByNameOrID return the NSX-T security group using the name or ID provided in the argument.
func (*VDC) GetServiceClass ¶ added in v0.6.0
func (v *VDC) GetServiceClass() infrapi.ServiceClass
GetServiceClass returns the service class of the VDC.
func (*VDC) GetStorageBillingModel ¶ added in v0.6.0
func (v *VDC) GetStorageBillingModel() infrapi.BillingModel
GetStorageBillingModel returns the storage billing model of the VDC.
func (*VDC) GetStorageProfiles ¶ added in v0.6.0
func (v *VDC) GetStorageProfiles() []infrapi.StorageProfile
GetStorageProfiles returns the storage profiles of the VDC.
func (VDC) GetVAPP ¶ added in v0.12.6
GetVAPP give you the vApp using the name provided in the argument.
func (*VDC) GetVCPUInMhz ¶ added in v0.6.0
GetVCPUInMhz returns the VCPU in MHz of the VDC.
func (VDC) IsVDCGroup ¶ added in v0.12.6
IsVDCGroup return true if the object is a VDC Group.
func (*VDC) RemoveStorageProfile ¶ added in v0.6.0
func (v *VDC) RemoveStorageProfile(storageProfileName infrapi.StorageProfile)
RemoveStorageProfile remove a storage profile from the VDC.
func (*VDC) Set ¶ added in v0.6.0
func (v *VDC) Set(vdc *infrapi.CAVVirtualDataCenter)
Set set the VDC.
func (*VDC) SetCPUAllocated ¶ added in v0.6.0
SetCPUAllocated set the CPU allocated of the VDC.
func (*VDC) SetDescription ¶ added in v0.6.0
SetDescription set the description of the VDC.
func (VDC) SetIPSet ¶ added in v0.12.6
func (v VDC) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)
SetIPSet set the NSX-T firewall group using the name provided in the argument.
func (*VDC) SetMemoryAllocated ¶ added in v0.6.0
SetMemoryAllocated set the memory allocated of the VDC.
func (*VDC) SetName ¶ added in v0.6.0
SetName set the name of the VDC. Name respects the following regex: ^[a-zA-Z0-9-_]{1,64}$
func (*VDC) SetStorageProfiles ¶ added in v0.6.0
func (v *VDC) SetStorageProfiles(storageProfiles []infrapi.StorageProfile)
SetStorageProfiles set the storage profiles of the VDC.
func (*VDC) SetVCPUInMhz ¶ added in v0.6.0
SetVCPUInMhz set the VCPU in MHz of the VDC.
type VDCAIps ¶
type VDCAIps []string
func (*VDCAIps) DeleteAllIPs ¶
DeleteAllIPs - Deletes all IPs from the list
func (*VDCAIps) IsIPExists ¶
IsIPExists - Returns true if the IP exists
type VDCGroup ¶ added in v0.6.0
func (VDCGroup) GetDescription ¶ added in v0.6.0
GetDescription returns the description of the VDC Group.
func (VDCGroup) GetIPSetByID ¶ added in v0.12.6
func (g VDCGroup) GetIPSetByID(id string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByID return the NSX-T firewall group using the ID provided in the argument.
func (VDCGroup) GetIPSetByName ¶ added in v0.12.6
func (g VDCGroup) GetIPSetByName(name string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByName return the NSX-T firewall group using the name provided in the argument.
func (VDCGroup) GetIPSetByNameOrID ¶ added in v0.12.6
func (g VDCGroup) GetIPSetByNameOrID(nameOrID string) (*govcd.NsxtFirewallGroup, error)
GetIPSetByNameOrID return the NSX-T firewall group using the name or ID provided in the argument.
func (VDCGroup) GetSecurityGroupByID ¶ added in v0.12.6
func (g VDCGroup) GetSecurityGroupByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByID return the NSX-T security group using the ID provided in the argument.
func (VDCGroup) GetSecurityGroupByName ¶ added in v0.12.6
func (g VDCGroup) GetSecurityGroupByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByName return the NSX-T security group using the name provided in the argument.
func (VDCGroup) GetSecurityGroupByNameOrID ¶ added in v0.12.6
func (g VDCGroup) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error)
GetSecurityGroupByNameOrID return the NSX-T security group using the name or ID provided in the argument.
func (VDCGroup) IsVDCGroup ¶ added in v0.12.6
IsVDCGroup return true if the object is a VDC Group.
func (VDCGroup) SetIPSet ¶ added in v0.12.6
func (g VDCGroup) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error)
SetIPSet set the NSX-T firewall group using the name provided in the argument.
type VDCOrVDCGroupInterface ¶ added in v0.12.6
type VDCOrVDCGroupInterface interface { // * Global Get // GetName returns the name of the VDC or VDC Group GetName() string // GetID returns the ID of the VDC or VDC Group GetID() string // GetDescription returns the description of the VDC or VDC Group GetDescription() string // * Global Is // IsVDCGroup returns true if the object is a VDC Group IsVDCGroup() bool // * Network GetOpenApiOrgVdcNetworkByName(string) (*govcd.OpenApiOrgVdcNetwork, error) // * Security Group GetSecurityGroupByID(nsxtFirewallGroupID string) (*govcd.NsxtFirewallGroup, error) GetSecurityGroupByName(nsxtFirewallGroupName string) (*govcd.NsxtFirewallGroup, error) GetSecurityGroupByNameOrID(nsxtFirewallGroupNameOrID string) (*govcd.NsxtFirewallGroup, error) // * IP Set GetIPSetByID(id string) (*govcd.NsxtFirewallGroup, error) GetIPSetByName(name string) (*govcd.NsxtFirewallGroup, error) GetIPSetByNameOrID(nameOrID string) (*govcd.NsxtFirewallGroup, error) SetIPSet(ipSetConfig *govcdtypes.NsxtFirewallGroup) (*govcd.NsxtFirewallGroup, error) }
Source Files ¶
- admin_org.go
- admin_vdc.go
- cloudavenue_bms.go
- cloudavenue_publicip.go
- cloudavenue_t0.go
- cloudavenue_vcda.go
- edgegw.go
- edgegw_firewall.go
- edgegw_firewall_types.go
- edgegw_types.go
- org.go
- querier.go
- s3.go
- s3_bucket.go
- s3_credential.go
- s3_user.go
- v1.go
- vapp.go
- vdc.go
- vdc_group.go
- vdc_group_types.go
- vdc_or_vdc_group.go
- vdc_or_vdc_group_types.go
- vdc_types.go