licensemanager.oracle.com/v1beta1
Back to API Reference
APIVersion: licensemanager.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages
No customer-visible package currently exposes licensemanager.oracle.com/v1beta1.
Resources
LicenseRecord
LicenseRecord is the Schema for the licenserecords API.
Plural: licenserecordsScope: NamespacedAPIVersion: licensemanager.oracle.com/v1beta1Sample: Sample (config/samples/licensemanager_v1beta1_licenserecord.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
LicenseRecordSpec defines the desired state of LicenseRecord.
| Field |
Description |
Type |
Required |
Default |
Enum |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
License record name. |
string |
Yes |
- |
- |
expirationDate |
The license record end date in RFC 3339 (https://tools.ietf.org/html/rfc3339) date format. Example: 2018-09-12 |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
isPerpetual |
Specifies if the license record term is perpertual. |
boolean |
Yes |
- |
- |
isUnlimited |
Specifies if the license count is unlimited. |
boolean |
Yes |
- |
- |
licenseCount |
The number of license units added by a user in a license record. Default 1 |
integer |
No |
- |
- |
productId |
The license record product ID. |
string |
No |
- |
- |
supportEndDate |
The license record support end date in RFC 3339 (https://tools.ietf.org/html/rfc3339) date format. Example: 2018-09-12 |
string |
No |
- |
- |
Status
LicenseRecordStatus defines the observed state of LicenseRecord.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) where the license record is created. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
The license record display name. Avoid entering confidential information. |
string |
No |
- |
- |
expirationDate |
The license record end date in RFC 3339 (https://tools.ietf.org/html/rfc3339) date format. Example: 2018-09-12 |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
The license record OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). |
string |
No |
- |
- |
isPerpetual |
Specifies if the license record term is perpertual. |
boolean |
No |
- |
- |
isUnlimited |
Specifies if the license count is unlimited. |
boolean |
No |
- |
- |
licenseCount |
The number of license units added by the user for the given license record. Default 1 |
integer |
No |
- |
- |
licenseUnit |
The product license unit. |
string |
No |
- |
- |
lifecycleState |
The current license record state. |
string |
No |
- |
- |
productId |
The license record product ID. |
string |
No |
- |
- |
productLicense |
The product license name with which the license record is associated. |
string |
No |
- |
- |
productLicenseId |
The product license OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) with which the license record is associated. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
supportEndDate |
The license record support end date in RFC 3339 (https://tools.ietf.org/html/rfc3339) date format. Example: 2018-09-12 |
string |
No |
- |
- |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The time the license record was created. An RFC 3339 (https://tools.ietf.org/html/rfc3339)-formatted datetime string. |
string |
No |
- |
- |
timeUpdated |
The time the license record was updated. An RFC 3339 (https://tools.ietf.org/html/rfc3339)-formatted datetime string. |
string |
No |
- |
- |
Status.status
Back to LicenseRecord status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to LicenseRecord status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to LicenseRecord status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to LicenseRecord status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
ProductLicense
ProductLicense is the Schema for the productlicenses API.
Plural: productlicensesScope: NamespacedAPIVersion: licensemanager.oracle.com/v1beta1Sample: Sample (config/samples/licensemanager_v1beta1_productlicense.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
ProductLicenseSpec defines the desired state of ProductLicense.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) where product licenses are created. |
string |
Yes |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
Name of the product license. |
string |
Yes |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
images |
The image details associated with the product license. |
list[object] |
No |
- |
- |
isVendorOracle |
Specifies if the product license vendor is Oracle or a third party. |
boolean |
Yes |
- |
- |
licenseUnit |
The product license unit. |
string |
Yes |
- |
- |
vendorName |
The product license vendor name, for example: Microsoft, RHEL, and so on. |
string |
No |
- |
- |
Spec.images[]
Back to ProductLicense spec
ProductLicenseImage defines nested fields for ProductLicense.Image.
| Field |
Description |
Type |
Required |
Default |
Enum |
listingId |
Marketplace image listing ID. |
string |
Yes |
- |
- |
packageVersion |
Image package version. |
string |
Yes |
- |
- |
Status
ProductLicenseStatus defines the observed state of ProductLicense.
| Field |
Description |
Type |
Required |
Default |
Enum |
activeLicenseRecordCount |
The number of active license records associated with the product license. |
integer |
No |
- |
- |
compartmentId |
The compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) where the product license is created. |
string |
No |
- |
- |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No |
- |
- |
displayName |
License record name |
string |
No |
- |
- |
freeformTags |
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No |
- |
- |
id |
The product license OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). |
string |
No |
- |
- |
images |
The images associated with the product license. |
list[object] |
No |
- |
- |
isOverSubscribed |
Specifies whether or not the product license is oversubscribed. |
boolean |
No |
- |
- |
isUnlimited |
Specifies if the license unit count is unlimited. |
boolean |
No |
- |
- |
isVendorOracle |
Specifies whether the vendor is Oracle or a third party. |
boolean |
No |
- |
- |
licenseUnit |
The product license unit. |
string |
No |
- |
- |
lifecycleState |
The current product license state. |
string |
No |
- |
- |
sdkStatus |
The current product license status. This uses a distinct JSON name so it can coexist with the OSOK status envelope. |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
statusDescription |
Status description for the current product license status. |
string |
No |
- |
- |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
- |
- |
timeCreated |
The time the product license was created. An RFC 3339 (https://tools.ietf.org/html/rfc3339)-formatted datetime string. |
string |
No |
- |
- |
timeUpdated |
The time the product license was updated. An RFC 3339 (https://tools.ietf.org/html/rfc3339)-formatted datetime string. |
string |
No |
- |
- |
totalActiveLicenseUnitCount |
The total number of licenses available for the product license, calculated by adding up all the license counts for active license records associated with the product license. |
integer |
No |
- |
- |
totalLicenseRecordCount |
The number of license records associated with the product license. |
integer |
No |
- |
- |
totalLicenseUnitsConsumed |
The number of license units consumed. Updated after each allocation run. |
number |
No |
- |
- |
vendorName |
The vendor of the ProductLicense |
string |
No |
- |
- |
Status.images[]
Back to ProductLicense status
ProductLicenseImage defines nested fields for ProductLicense.Image.
| Field |
Description |
Type |
Required |
Default |
Enum |
listingId |
Marketplace image listing ID. |
string |
Yes |
- |
- |
packageVersion |
Image package version. |
string |
Yes |
- |
- |
Status.status
Back to ProductLicense status
| Field |
Description |
Type |
Required |
Default |
Enum |
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. |
object |
No |
- |
- |
conditions |
- |
list[object] |
No |
- |
- |
createdAt |
- |
string (date-time) |
No |
- |
- |
deletedAt |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
ocid |
- |
string |
No |
- |
- |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
requestedAt |
- |
string (date-time) |
No |
- |
- |
updatedAt |
- |
string (date-time) |
No |
- |
- |
Status.status.async
Back to ProductLicense status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field |
Description |
Type |
Required |
Default |
Enum |
current |
- |
object |
No |
- |
- |
Status.status.async.current
Back to ProductLicense status
| Field |
Description |
Type |
Required |
Default |
Enum |
message |
- |
string |
No |
- |
- |
normalizedClass |
- |
string |
Yes |
- |
attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- |
number |
No |
- |
- |
phase |
- |
string |
Yes |
- |
create, delete, update |
rawOperationType |
- |
string |
No |
- |
- |
rawStatus |
- |
string |
No |
- |
- |
source |
- |
string |
Yes |
- |
lifecycle, none, workrequest |
updatedAt |
- |
string (date-time) |
Yes |
- |
- |
workRequestId |
- |
string |
No |
- |
- |
Status.status.conditions[]
Back to ProductLicense status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |