Show / Hide Table of Contents

Class Byol

An Oracle Cloud VMware Solution Bring-Your-Own-License (BYOL), is a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.

Inheritance
object
Byol
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.OcvpService.Models
Assembly: OCI.DotNetSDK.Ocvp.dll
Syntax
public class Byol

Properties

AvailableUnits

Declaration
[Required(ErrorMessage = "AvailableUnits is required.")]
[JsonProperty(PropertyName = "availableUnits")]
public int? AvailableUnits { get; set; }
Property Value
Type Description
int?

The quantity of licensed units that not yet allocated to specific region.

Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the BYOL.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A description of the BYOL.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A descriptive name for the BYOL.

Remarks

Required

EntitlementKey

Declaration
[Required(ErrorMessage = "EntitlementKey is required.")]
[JsonProperty(PropertyName = "entitlementKey")]
public string EntitlementKey { get; set; }
Property Value
Type Description
string

The Broadcom-supplied identifier of a BYOL license.

Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the BYOL.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Byol.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Byol.LifecycleStateEnum?

The current state of the BYOL.

Remarks

Required

SoftwareType

Declaration
[Required(ErrorMessage = "SoftwareType is required.")]
[JsonProperty(PropertyName = "softwareType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Byol.SoftwareTypeEnum? SoftwareType { get; set; }
Property Value
Type Description
Byol.SoftwareTypeEnum?

The type of VMware software the BYOL applies to. Supported values:

  • VCF (VMware Cloud Foundation)
  • VSAN (VMware vSAN)
  • VDEFEND (VMware vDefend Firewall)
  • AVI_LOAD_BALANCER (VMware Avi Load Balancer)
Remarks

Required

SystemTags

Declaration
[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeTermEnd

Declaration
[Required(ErrorMessage = "TimeTermEnd is required.")]
[JsonProperty(PropertyName = "timeTermEnd")]
public DateTime? TimeTermEnd { get; set; }
Property Value
Type Description
DateTime?

The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.

Remarks

Required

TimeTermStart

Declaration
[Required(ErrorMessage = "TimeTermStart is required.")]
[JsonProperty(PropertyName = "timeTermStart")]
public DateTime? TimeTermStart { get; set; }
Property Value
Type Description
DateTime?

The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the BYOL was updated, in the format defined by RFC3339.

Remarks

Required

TotalUnits

Declaration
[Required(ErrorMessage = "TotalUnits is required.")]
[JsonProperty(PropertyName = "totalUnits")]
public int? TotalUnits { get; set; }
Property Value
Type Description
int?

Total quantity of licensed units for the specified softwareType:

  • VCF, VDEFEND: number of OCPUs
  • VSAN: storage capacity in TiB (tebibytes)
  • AVI_LOAD_BALANCER: number of instances
Remarks

Required

In this article
Back to top