1. Packages
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. Ocvp
  6. Byol
Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.Ocvp.Byol

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.9.0
published on Thursday, Apr 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This resource provides the Byol resource in Oracle Cloud Infrastructure Oracle Cloud VMware Solution service. Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/vmware/latest/Byol

    Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/ocvp

    Creates an Oracle Cloud VMware Solution Bring-You-Own-License (BYOL).

    Use the WorkRequest operations to track the creation of the BYOL.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testByol = new oci.ocvp.Byol("test_byol", {
    compartmentId: compartmentId,
    displayName: byolDisplayName,
    entitlementKey: byolEntitlementKey,
    softwareType: byolSoftwareType,
    timeTermEnd: byolTimeTermEnd,
    timeTermStart: byolTimeTermStart,
    totalUnits: byolTotalUnits,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: byolDescription,
    freeformTags: {
        Department: "Finance",
    },
});

    import pulumi
import pulumi_oci as oci

test_byol = oci.ocvp.Byol("test_byol",
    compartment_id=compartment_id,
    display_name=byol_display_name,
    entitlement_key=byol_entitlement_key,
    software_type=byol_software_type,
    time_term_end=byol_time_term_end,
    time_term_start=byol_time_term_start,
    total_units=byol_total_units,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=byol_description,
    freeform_tags={
        "Department": "Finance",
    })

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/ocvp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ocvp.NewByol(ctx, "test_byol", &ocvp.ByolArgs{
			CompartmentId:  pulumi.Any(compartmentId),
			DisplayName:    pulumi.Any(byolDisplayName),
			EntitlementKey: pulumi.Any(byolEntitlementKey),
			SoftwareType:   pulumi.Any(byolSoftwareType),
			TimeTermEnd:    pulumi.Any(byolTimeTermEnd),
			TimeTermStart:  pulumi.Any(byolTimeTermStart),
			TotalUnits:     pulumi.Any(byolTotalUnits),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(byolDescription),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testByol = new Oci.Ocvp.Byol("test_byol", new()
    {
        CompartmentId = compartmentId,
        DisplayName = byolDisplayName,
        EntitlementKey = byolEntitlementKey,
        SoftwareType = byolSoftwareType,
        TimeTermEnd = byolTimeTermEnd,
        TimeTermStart = byolTimeTermStart,
        TotalUnits = byolTotalUnits,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = byolDescription,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Ocvp.Byol;
import com.pulumi.oci.Ocvp.ByolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testByol = new Byol("testByol", ByolArgs.builder()
            .compartmentId(compartmentId)
            .displayName(byolDisplayName)
            .entitlementKey(byolEntitlementKey)
            .softwareType(byolSoftwareType)
            .timeTermEnd(byolTimeTermEnd)
            .timeTermStart(byolTimeTermStart)
            .totalUnits(byolTotalUnits)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(byolDescription)
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}

    resources:
  testByol:
    type: oci:Ocvp:Byol
    name: test_byol
    properties:
      compartmentId: ${compartmentId}
      displayName: ${byolDisplayName}
      entitlementKey: ${byolEntitlementKey}
      softwareType: ${byolSoftwareType}
      timeTermEnd: ${byolTimeTermEnd}
      timeTermStart: ${byolTimeTermStart}
      totalUnits: ${byolTotalUnits}
      definedTags:
        Operations.CostCenter: '42'
      description: ${byolDescription}
      freeformTags:
        Department: Finance

    Create Byol Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Byol(name: string, args: ByolArgs, opts?: CustomResourceOptions);
    @overload
def Byol(resource_name: str,
         args: ByolArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Byol(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         compartment_id: Optional[str] = None,
         display_name: Optional[str] = None,
         entitlement_key: Optional[str] = None,
         software_type: Optional[str] = None,
         time_term_end: Optional[str] = None,
         time_term_start: Optional[str] = None,
         total_units: Optional[int] = None,
         defined_tags: Optional[Mapping[str, str]] = None,
         description: Optional[str] = None,
         freeform_tags: Optional[Mapping[str, str]] = None)
    func NewByol(ctx *Context, name string, args ByolArgs, opts ...ResourceOption) (*Byol, error)
    public Byol(string name, ByolArgs args, CustomResourceOptions? opts = null)
    public Byol(String name, ByolArgs args)
public Byol(String name, ByolArgs args, CustomResourceOptions options)

    type: oci:Ocvp:Byol
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ByolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ByolArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ByolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ByolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ByolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Byol Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Byol resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    DisplayName string
    (Updatable) A descriptive name for the BYOL.
    EntitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    SoftwareType string
    (Updatable) 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)
    TimeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    (Updatable) 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
    TotalUnits int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the BYOL.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    DisplayName string
    (Updatable) A descriptive name for the BYOL.
    EntitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    SoftwareType string
    (Updatable) 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)
    TimeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    (Updatable) 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
    TotalUnits int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the BYOL.
    FreeformTags map[string]string
    (Updatable) 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"}
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL.
    displayName String
    (Updatable) A descriptive name for the BYOL.
    entitlementKey String
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    softwareType String
    (Updatable) 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)
    timeTermEnd String
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    (Updatable) 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
    totalUnits Integer

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the BYOL.
    freeformTags Map<String,String>
    (Updatable) 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"}
    compartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    displayName string
    (Updatable) A descriptive name for the BYOL.
    entitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    softwareType string
    (Updatable) 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)
    timeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart string
    (Updatable) 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
    totalUnits number

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A description of the BYOL.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    compartment_id str
    (Updatable) The OCID of the compartment that contains the BYOL.
    display_name str
    (Updatable) A descriptive name for the BYOL.
    entitlement_key str
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    software_type str
    (Updatable) 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)
    time_term_end str
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    time_term_start str
    (Updatable) 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
    total_units int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A description of the BYOL.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL.
    displayName String
    (Updatable) A descriptive name for the BYOL.
    entitlementKey String
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    softwareType String
    (Updatable) 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)
    timeTermEnd String
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    (Updatable) 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
    totalUnits Number

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the BYOL.
    freeformTags Map<String>
    (Updatable) 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"}

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Byol resource produces the following output properties:

    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the BYOL.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the BYOL.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    availableUnits Integer
    The quantity of licensed units that not yet allocated to specific region.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the BYOL.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL was updated, in the format defined by RFC3339.
    availableUnits number
    The quantity of licensed units that not yet allocated to specific region.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the BYOL.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    available_units int
    The quantity of licensed units that not yet allocated to specific region.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the BYOL.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    time_created str
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the BYOL was updated, in the format defined by RFC3339.
    availableUnits Number
    The quantity of licensed units that not yet allocated to specific region.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the BYOL.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the BYOL was updated, in the format defined by RFC3339.

    Look up Existing Byol Resource

    Get an existing Byol resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ByolState, opts?: CustomResourceOptions): Byol
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        available_units: Optional[int] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        entitlement_key: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        software_type: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_term_end: Optional[str] = None,
        time_term_start: Optional[str] = None,
        time_updated: Optional[str] = None,
        total_units: Optional[int] = None) -> Byol
    func GetByol(ctx *Context, name string, id IDInput, state *ByolState, opts ...ResourceOption) (*Byol, error)
    public static Byol Get(string name, Input<string> id, ByolState? state, CustomResourceOptions? opts = null)
    public static Byol get(String name, Output<String> id, ByolState state, CustomResourceOptions options)
    resources:  _:    type: oci:Ocvp:Byol    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the BYOL.
    DisplayName string
    (Updatable) A descriptive name for the BYOL.
    EntitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    SoftwareType string
    (Updatable) 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)
    State string
    The current state of the BYOL.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    (Updatable) 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
    TimeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    TotalUnits int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AvailableUnits int
    The quantity of licensed units that not yet allocated to specific region.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) A description of the BYOL.
    DisplayName string
    (Updatable) A descriptive name for the BYOL.
    EntitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    FreeformTags map[string]string
    (Updatable) 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"}
    SoftwareType string
    (Updatable) 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)
    State string
    The current state of the BYOL.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    TimeTermStart string
    (Updatable) 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
    TimeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    TotalUnits int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availableUnits Integer
    The quantity of licensed units that not yet allocated to specific region.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the BYOL.
    displayName String
    (Updatable) A descriptive name for the BYOL.
    entitlementKey String
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    freeformTags Map<String,String>
    (Updatable) 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"}
    softwareType String
    (Updatable) 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)
    state String
    The current state of the BYOL.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    (Updatable) 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
    timeUpdated String
    The date and time the BYOL was updated, in the format defined by RFC3339.
    totalUnits Integer

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availableUnits number
    The quantity of licensed units that not yet allocated to specific region.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the BYOL.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) A description of the BYOL.
    displayName string
    (Updatable) A descriptive name for the BYOL.
    entitlementKey string
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    softwareType string
    (Updatable) 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)
    state string
    The current state of the BYOL.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated string
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd string
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart string
    (Updatable) 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
    timeUpdated string
    The date and time the BYOL was updated, in the format defined by RFC3339.
    totalUnits number

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    available_units int
    The quantity of licensed units that not yet allocated to specific region.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the BYOL.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) A description of the BYOL.
    display_name str
    (Updatable) A descriptive name for the BYOL.
    entitlement_key str
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    software_type str
    (Updatable) 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)
    state str
    The current state of the BYOL.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    time_created str
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_term_end str
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    time_term_start str
    (Updatable) 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
    time_updated str
    The date and time the BYOL was updated, in the format defined by RFC3339.
    total_units int

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availableUnits Number
    The quantity of licensed units that not yet allocated to specific region.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the BYOL.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) A description of the BYOL.
    displayName String
    (Updatable) A descriptive name for the BYOL.
    entitlementKey String
    (Updatable) The Broadcom-supplied identifier of a BYOL license.
    freeformTags Map<String>
    (Updatable) 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"}
    softwareType String
    (Updatable) 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)
    state String
    The current state of the BYOL.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeTermEnd String
    (Updatable) The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.
    timeTermStart String
    (Updatable) 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
    timeUpdated String
    The date and time the BYOL was updated, in the format defined by RFC3339.
    totalUnits Number

    (Updatable) 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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    Byols can be imported using the id, e.g.

    $ pulumi import oci:Ocvp/byol:Byol test_byol "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.9.0
    published on Thursday, Apr 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.