Skip to content

osmanagementhub.oracle.com/v1beta1

Back to API Reference

APIVersion: osmanagementhub.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 osmanagementhub.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
LifecycleEnvironment Namespaced Sample -
ManagedInstanceGroup Namespaced Sample -
ManagementStation Namespaced Sample -
Profile Namespaced Sample -
ScheduledJob Namespaced Sample -
SoftwareSource Namespaced Sample -

LifecycleEnvironment

LifecycleEnvironment is the Schema for the lifecycleenvironments API.

  • Plural: lifecycleenvironments
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_lifecycleenvironment.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

LifecycleEnvironmentSpec defines the desired state of LifecycleEnvironment.

Field Description Type Required Default Enum
archType The CPU architecture of the managed instances in the lifecycle environment. string Yes - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle environment. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified information about the lifecycle environment. Avoid entering confidential information. string No - -
displayName A user-friendly name for the lifecycle environment. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
location The location of managed instances attached to the lifecycle environment. If no location is provided, the default is 'ON_PREMISE.' string No - -
osFamily The operating system of the managed instances in the lifecycle environment. string Yes - -
stages User-specified list of ranked lifecycle stages used within the lifecycle environment. list[object] Yes - -
vendorName The vendor of the operating system used by the managed instances in the lifecycle environment. string Yes - -

Spec.stages[]

Back to LifecycleEnvironment spec

LifecycleEnvironmentStage defines nested fields for LifecycleEnvironment.Stage.

Field Description Type Required Default Enum
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A user-friendly name for the lifecycle stage. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
rank User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. integer Yes - -

Status

LifecycleEnvironmentStatus defines the observed state of LifecycleEnvironment.

Field Description Type Required Default Enum
archType The CPU architecture of the managed instances in the lifecycle environment. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle environment. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified information about the lifecycle environment. string No - -
displayName The user-friendly name for the lifecycle environment. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. string No - -
lifecycleState The current state of the lifecycle environment. string No - -
location The location of managed instances attached to the lifecycle environment. string No - -
managedInstanceIds List of managed instance OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) assigned to the lifecycle stage. list[object] No - -
osFamily The operating system of the managed instances in the lifecycle environment. string No - -
stages User-specified list of lifecycle stages used within the lifecycle environment. list[object] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the lifecycle environment was created (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeModified The time the lifecycle environment was last modified (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
vendorName The vendor of the operating system used by the managed instances in the lifecycle environment. string No - -

Status.managedInstanceIds[]

Back to LifecycleEnvironment status

LifecycleEnvironmentManagedInstanceId defines nested fields for LifecycleEnvironment.ManagedInstanceId.

Field Description Type Required Default Enum
displayName Managed instance name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. string No - -

Status.stages[]

Back to LifecycleEnvironment status

LifecycleEnvironmentStage defines nested fields for LifecycleEnvironment.Stage.

Field Description Type Required Default Enum
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
displayName A user-friendly name for the lifecycle stage. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
rank User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment. integer Yes - -

Status.status

Back to LifecycleEnvironment 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 LifecycleEnvironment 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 LifecycleEnvironment 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 LifecycleEnvironment status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ManagedInstanceGroup

ManagedInstanceGroup is the Schema for the managedinstancegroups API.

  • Plural: managedinstancegroups
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_managedinstancegroup.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ManagedInstanceGroupSpec defines the desired state of ManagedInstanceGroup.

Field Description Type Required Default Enum
archType The CPU architecture type of the managed instances that will be attached to this group. string Yes - -
autonomousSettings ManagedInstanceGroupAutonomousSettings defines nested fields for ManagedInstanceGroup.AutonomousSettings. object No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance group. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description of the managed instance group. Avoid entering confidential information. string No - -
displayName A user-friendly name for the managed instance group. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
location The location of managed instances attached to the group. If no location is provided, the default is on premises. string No - -
managedInstanceIds The list of managed instance OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to be added to the group. list[string] No - -
notificationTopicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. string No - -
osFamily The operating system type of the managed instances that will be attached to this group. string Yes - -
softwareSourceIds The list of software source OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) available to the managed instances in the group. list[string] No - -
vendorName The vendor of the operating system that will be used by the managed instances in the group. string Yes - -

Spec.autonomousSettings

Back to ManagedInstanceGroup spec

ManagedInstanceGroupAutonomousSettings defines nested fields for ManagedInstanceGroup.AutonomousSettings.

Field Description Type Required Default Enum
isDataCollectionAuthorized Indicates whether Autonomous Linux will collect crash files. boolean No - -

Status

ManagedInstanceGroupStatus defines the observed state of ManagedInstanceGroup.

Field Description Type Required Default Enum
archType The CPU architecture of the instances in the managed instance group. string No - -
autonomousSettings ManagedInstanceGroupAutonomousSettings defines nested fields for ManagedInstanceGroup.AutonomousSettings. object No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance group. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified information about the managed instance group. string No - -
displayName A user-friendly name for the managed instance group. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. string No - -
isManagedByAutonomousLinux Indicates whether the Autonomous Linux service manages the group. boolean No - -
lifecycleState The current state of the managed instance group. string No - -
location The location of managed instances attached to the group. string No - -
managedInstanceCount The number of managed instances in the group. integer No - -
managedInstanceIds The list of managed instance OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) attached to the managed instance group. list[string] No - -
notificationTopicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. string No - -
osFamily The operating system type of the instances in the managed instance group. string No - -
pendingJobCount The number of scheduled jobs pending against the managed instance group. integer No - -
softwareSourceIds The list of software source OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that the managed instance group will use. list[object] No - -
softwareSources The list of software sources that the managed instance group will use. list[object] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the managed instance group was created (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeModified The time the managed instance group was last modified (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
vendorName The vendor of the operating system used by the managed instances in the group. string No - -

Status.autonomousSettings

Back to ManagedInstanceGroup status

ManagedInstanceGroupAutonomousSettings defines nested fields for ManagedInstanceGroup.AutonomousSettings.

Field Description Type Required Default Enum
isDataCollectionAuthorized Indicates whether Autonomous Linux will collect crash files. boolean No - -

Status.softwareSourceIds[]

Back to ManagedInstanceGroup status

ManagedInstanceGroupSoftwareSourceId defines nested fields for ManagedInstanceGroup.SoftwareSourceId.

Field Description Type Required Default Enum
description Software source description. string No - -
displayName Software source name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. string No - -
isMandatoryForAutonomousLinux Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. boolean No - -
softwareSourceType Type of the software source. string No - -

Status.softwareSources[]

Back to ManagedInstanceGroup status

ManagedInstanceGroupSoftwareSource defines nested fields for ManagedInstanceGroup.SoftwareSource.

Field Description Type Required Default Enum
description Software source description. string No - -
displayName Software source name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. string No - -
isMandatoryForAutonomousLinux Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. boolean No - -
softwareSourceType Type of the software source. string No - -

Status.status

Back to ManagedInstanceGroup 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 ManagedInstanceGroup 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 ManagedInstanceGroup 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 ManagedInstanceGroup status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ManagementStation

ManagementStation is the Schema for the managementstations API.

  • Plural: managementstations
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_managementstation.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ManagementStationSpec defines the desired state of ManagementStation.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the management station. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description of the management station. Avoid entering confidential information. string No - -
displayName User-friendly name for the management station. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
hostname Hostname of the management station. string Yes - -
isAutoConfigEnabled When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station. boolean No - -
mirror ManagementStationMirror defines nested fields for ManagementStation.Mirror. object Yes - -
proxy ManagementStationProxy defines nested fields for ManagementStation.Proxy. object Yes - -

Spec.mirror

Back to ManagementStation spec

ManagementStationMirror defines nested fields for ManagementStation.Mirror.

Field Description Type Required Default Enum
directory Path to the data volume on the management station where software source mirrors are stored. string Yes - -
isSslverifyEnabled When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station. boolean No - -
port Default mirror listening port for http. string Yes - -
sslcert Path to the SSL cerfificate. string No - -
sslport Default mirror listening port for https. string Yes - -

Spec.proxy

Back to ManagementStation spec

ManagementStationProxy defines nested fields for ManagementStation.Proxy.

Field Description Type Required Default Enum
forward The URL the proxy will forward to. string No - -
hosts List of hosts. list[string] No - -
isEnabled Indicates if the proxy should be enabled or disabled. Default is enabled. boolean Yes - -
port Listening port used for the proxy. string No - -

Status

ManagementStationStatus defines the observed state of ManagementStation.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the management station. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description for the management station. string No - -
displayName A user-friendly name for the management station. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
health ManagementStationHealth defines nested fields for ManagementStation.Health. object No - -
healthState Overall health status of the managment station. string No - -
hostname Hostname of the management station. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station. string No - -
isAutoConfigEnabled When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station. boolean No - -
lifecycleState The current state of the management station. string No - -
location The location of the instance that is acting as the management station. string No - -
managedInstanceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance that is acting as the management station. string No - -
mirror ManagementStationMirror defines nested fields for ManagementStation.Mirror. object No - -
mirrorCapacity A decimal number representing the amount of mirror capacity used by the sync. integer No - -
mirrorPackageCount The total number of all packages within the mirrored software sources. integer No - -
mirrorSize The total size of all software source mirrors in bytes. integer (int64) No - -
mirrorStorageAvailableSize Amount of available mirror storage in bytes. integer (int64) No - -
mirrorStorageSize Total mirror storage size in bytes. integer (int64) No - -
mirrorSyncStatus ManagementStationMirrorSyncStatus defines nested fields for ManagementStation.MirrorSyncStatus. object No - -
mirrorUniquePackageCount The total number of unique packages within the mirrored software sources on the station. Each package is counted only once, regardless of how many versions it has. integer No - -
overallPercentage A decimal number representing the progress of the current mirror sync. integer No - -
overallState Current state of the mirror sync for the management station. string No - -
peerManagementStations A list of other management stations that are behind the same load balancer within a high availability configuration. Stations are identified as peers if they have the same hostname and compartment. list[object] No - -
profileId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the registration profile used for the management station. string No - -
proxy ManagementStationProxy defines nested fields for ManagementStation.Proxy. object No - -
scheduledJobId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job for the mirror sync. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeNextExecution The date and time of the next scheduled mirror sync (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
totalMirrors The number of software sources that the station is mirroring. integer No - -

Status.health

Back to ManagementStation status

ManagementStationHealth defines nested fields for ManagementStation.Health.

Field Description Type Required Default Enum
description Explanation of the health status. string No - -
state Overall health status of the management station. string No - -

Status.mirror

Back to ManagementStation status

ManagementStationMirror defines nested fields for ManagementStation.Mirror.

Field Description Type Required Default Enum
directory Path to the data volume on the management station where software source mirrors are stored. string Yes - -
isSslverifyEnabled When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station. boolean No - -
port Default mirror listening port for http. string Yes - -
sslcert Path to the SSL cerfificate. string No - -
sslport Default mirror listening port for https. string Yes - -

Status.mirrorSyncStatus

Back to ManagementStation status

ManagementStationMirrorSyncStatus defines nested fields for ManagementStation.MirrorSyncStatus.

Field Description Type Required Default Enum
failed Total number of software sources that failed to sync. integer No - -
queued Total number of software sources that are queued for sync. integer No - -
synced Total number of software sources that successfully synced. integer No - -
syncing Total number of software sources currently syncing. integer No - -
unsynced Total number of software sources that have not yet been synced. integer No - -

Status.peerManagementStations[]

Back to ManagementStation status

ManagementStationPeerManagementStation defines nested fields for ManagementStation.PeerManagementStation.

Field Description Type Required Default Enum
displayName User-friendly name for the management station. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station. string No - -

Status.proxy

Back to ManagementStation status

ManagementStationProxy defines nested fields for ManagementStation.Proxy.

Field Description Type Required Default Enum
forward The URL the proxy will forward to. string No - -
hosts List of hosts. list[string] No - -
isEnabled Indicates if the proxy should be enabled or disabled. Default is enabled. boolean Yes - -
port Listening port used for the proxy. string No - -

Status.status

Back to ManagementStation 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 ManagementStation 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 ManagementStation 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 ManagementStation status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Profile

Profile is the Schema for the profiles API.

  • Plural: profiles
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_profile.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ProfileSpec defines the desired state of Profile.

Field Description Type Required Default Enum
archType The architecture type. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description of the registration profile. string No - -
displayName A user-friendly name. Does not have to be unique and you can change the name later. Avoid entering confidential information. string Yes - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
isDefaultProfile Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. boolean No - -
jsonData - string No - -
lifecycleStageId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage that the instance will be associated with. string No - -
managedInstanceGroupId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group that the instance will join after registration. string No - -
managementStationId description: The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an instance once registered. This is required when creating a profile for non-OCI instances. string No - -
osFamily The operating system family. string No - -
profileType - string No - -
registrationType The type of instance to register. string No - -
softwareSourceIds The list of software source OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that the registration profile will use. list[string] No - -
vendorName The vendor of the operating system for the instance. string No - -

Status

ProfileStatus defines the observed state of Profile.

Field Description Type Required Default Enum
archType The architecture type. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the registration profile. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description The description of the registration profile. string No - -
displayName A user-friendly name for the profile. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the registration profile. string No - -
isDefaultProfile Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. boolean No - -
isServiceProvidedProfile Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances. boolean No - -
jsonData - string No - -
lifecycleEnvironment ProfileLifecycleEnvironment defines nested fields for Profile.LifecycleEnvironment. object No - -
lifecycleStage ProfileLifecycleStage defines nested fields for Profile.LifecycleStage. object No - -
lifecycleState The current state of the registration profile. string No - -
managedInstanceGroup ProfileManagedInstanceGroup defines nested fields for Profile.ManagedInstanceGroup. object No - -
managementStationId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the management station to associate with an instance once registered. Management stations are only used by non-OCI instances. string No - -
osFamily The operating system family. string No - -
profileType - string No - -
profileVersion The version of the profile. The version is automatically incremented each time the profiled is edited. string No - -
registrationType The type of instance to register. string No - -
softwareSources The list of software sources that the registration profile will use. list[object] No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the registration profile was created (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeModified The time the registration profile was last modified (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
vendorName The vendor of the operating system for the instance. string No - -

Status.lifecycleEnvironment

Back to Profile status

ProfileLifecycleEnvironment defines nested fields for Profile.LifecycleEnvironment.

Field Description Type Required Default Enum
displayName Lifecycle environment name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment. string No - -

Status.lifecycleStage

Back to Profile status

ProfileLifecycleStage defines nested fields for Profile.LifecycleStage.

Field Description Type Required Default Enum
displayName Lifecycle stage name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage. string No - -

Status.managedInstanceGroup

Back to Profile status

ProfileManagedInstanceGroup defines nested fields for Profile.ManagedInstanceGroup.

Field Description Type Required Default Enum
displayName Managed instance group name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. string No - -

Status.softwareSources[]

Back to Profile status

ProfileSoftwareSource defines nested fields for Profile.SoftwareSource.

Field Description Type Required Default Enum
description Software source description. string No - -
displayName Software source name. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. string No - -
isMandatoryForAutonomousLinux Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. boolean No - -
softwareSourceType Type of the software source. string No - -

Status.status

Back to Profile 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 Profile 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 Profile 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 Profile status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

ScheduledJob

ScheduledJob is the Schema for the scheduledjobs API.

  • Plural: scheduledjobs
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_scheduledjob.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ScheduledJobSpec defines the desired state of ScheduledJob.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the scheduled job. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description of the scheduled job. Avoid entering confidential information. string No - -
displayName User-friendly name for the scheduled job. Does not have to be unique and you can change the name later. Avoid entering confidential information. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
isManagedByAutonomousLinux Indicates whether this scheduled job is managed by the Autonomous Linux service. boolean No - -
isSubcompartmentIncluded Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) (root compartment). boolean No - -
lifecycleStageIds The lifecycle stage OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or managedCompartmentIds. list[string] No - -
locations The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty. list[string] No - -
managedCompartmentIds The compartment OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. To apply the job to all compartments in the tenancy, set this to the tenancy OCID (root compartment) and set isSubcompartmentIncluded to true. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or lifecycleStageIds. list[string] No - -
managedInstanceGroupIds The managed instance group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedCompartmentIds, or lifecycleStageIds. list[string] No - -
managedInstanceIds The managed instance OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceGroupIds, or managedCompartmentIds, or lifecycleStageIds. list[string] No - -
operations The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * UPDATE_PACKAGES * UPDATE_ALL * UPDATE_SECURITY * UPDATE_BUGFIX * UPDATE_ENHANCEMENT * UPDATE_OTHER * UPDATE_KSPLICE_USERSPACE * UPDATE_KSPLICE_KERNEL list[object] Yes - -
recurringRule The frequency schedule for a recurring scheduled job. string No - -
retryIntervals The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries. list[integer] No - -
scheduleType The type of scheduling frequency for the scheduled job. string Yes - -
timeNextExecution The desired time of the next execution of this scheduled job (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string Yes - -
workRequestId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the work request that will be rerun. string No - -

Spec.operations[]

Back to ScheduledJob spec

ScheduledJobOperation defines nested fields for ScheduledJob.Operation.

Field Description Type Required Default Enum
manageModuleStreamsDetails ScheduledJobOperationManageModuleStreamsDetails defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails. object No - -
operationType The type of operation this scheduled job performs. string Yes - -
packageNames The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages. list[string] No - -
rebootTimeoutInMins The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the timeout, the service marks the reboot job as failed. integer No - -
softwareSourceIds The software source OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This parameter only applies when the scheduled job is for attaching or detaching software sources. list[string] No - -
switchModuleStreamsDetails ScheduledJobOperationSwitchModuleStreamsDetails defines nested fields for ScheduledJob.Operation.SwitchModuleStreamsDetails. object No - -
windowsUpdateNames Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'. list[string] No - -

Spec.operations[].manageModuleStreamsDetails

Back to ScheduledJob spec

ScheduledJobOperationManageModuleStreamsDetails defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.

Field Description Type Required Default Enum
disable The set of module streams to disable. list[object] No - -
enable The set of module streams to enable. list[object] No - -
install The set of module stream profiles to install. list[object] No - -
remove The set of module stream profiles to remove. list[object] No - -

Spec.operations[].manageModuleStreamsDetails.disable[]

Back to ScheduledJob spec

ScheduledJobOperationManageModuleStreamsDetailsDisable defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Disable.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Spec.operations[].manageModuleStreamsDetails.enable[]

Back to ScheduledJob spec

ScheduledJobOperationManageModuleStreamsDetailsEnable defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Enable.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Spec.operations[].manageModuleStreamsDetails.install[]

Back to ScheduledJob spec

ScheduledJobOperationManageModuleStreamsDetailsInstall defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Install.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
profileName The name of a profile of the specified module stream. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Spec.operations[].manageModuleStreamsDetails.remove[]

Back to ScheduledJob spec

ScheduledJobOperationManageModuleStreamsDetailsRemove defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Remove.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
profileName The name of a profile of the specified module stream. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Spec.operations[].switchModuleStreamsDetails

Back to ScheduledJob spec

ScheduledJobOperationSwitchModuleStreamsDetails defines nested fields for ScheduledJob.Operation.SwitchModuleStreamsDetails.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status

ScheduledJobStatus defines the observed state of ScheduledJob.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the scheduled job. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description for the scheduled job. string No - -
displayName User-friendly name for the scheduled job. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job. string No - -
isManagedByAutonomousLinux Indicates whether this scheduled job is managed by the Autonomous Linux service. boolean No - -
isRestricted Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags. boolean No - -
isSubcompartmentIncluded Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) (root compartment). boolean No - -
lifecycleStageIds The lifecycle stage OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds. list[string] No - -
lifecycleState The current state of the scheduled job. string No - -
locations The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty. list[string] No - -
managedCompartmentIds The compartment OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds. list[string] No - -
managedInstanceGroupIds The managed instance group OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds. list[string] No - -
managedInstanceIds The managed instance OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds. list[string] No - -
operations The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * UPDATE_PACKAGES * UPDATE_ALL * UPDATE_SECURITY * UPDATE_BUGFIX * UPDATE_ENHANCEMENT * UPDATE_OTHER * UPDATE_KSPLICE_USERSPACE * UPDATE_KSPLICE_KERNEL list[object] No - -
recurringRule The frequency schedule for a recurring scheduled job. string No - -
retryIntervals The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries. list[integer] No - -
scheduleType The type of scheduling frequency for the job. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time this scheduled job was created (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeLastExecution The time of the last execution of this scheduled job (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeNextExecution The time of the next execution of this scheduled job (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeUpdated The time this scheduled job was updated (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
workRequestId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the work request that will be rerun. string No - -
workRequestIds The list of work request OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) associated with this scheduled job. list[string] No - -

Status.operations[]

Back to ScheduledJob status

ScheduledJobOperation defines nested fields for ScheduledJob.Operation.

Field Description Type Required Default Enum
manageModuleStreamsDetails ScheduledJobOperationManageModuleStreamsDetails defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails. object No - -
operationType The type of operation this scheduled job performs. string Yes - -
packageNames The names of the target packages. This parameter only applies when the scheduled job is for installing, updating, or removing packages. list[string] No - -
rebootTimeoutInMins The number of minutes the service waits for the reboot to complete. If the instance doesn't reboot within the timeout, the service marks the reboot job as failed. integer No - -
softwareSourceIds The software source OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This parameter only applies when the scheduled job is for attaching or detaching software sources. list[string] No - -
switchModuleStreamsDetails ScheduledJobOperationSwitchModuleStreamsDetails defines nested fields for ScheduledJob.Operation.SwitchModuleStreamsDetails. object No - -
windowsUpdateNames Unique identifier for the Windows update. This parameter only applies if the scheduled job is for installing Windows updates. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. For example: '6981d463-cd91-4a26-b7c4-ea4ded9183ed'. list[string] No - -

Status.operations[].manageModuleStreamsDetails

Back to ScheduledJob status

ScheduledJobOperationManageModuleStreamsDetails defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.

Field Description Type Required Default Enum
disable The set of module streams to disable. list[object] No - -
enable The set of module streams to enable. list[object] No - -
install The set of module stream profiles to install. list[object] No - -
remove The set of module stream profiles to remove. list[object] No - -

Status.operations[].manageModuleStreamsDetails.disable[]

Back to ScheduledJob status

ScheduledJobOperationManageModuleStreamsDetailsDisable defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Disable.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status.operations[].manageModuleStreamsDetails.enable[]

Back to ScheduledJob status

ScheduledJobOperationManageModuleStreamsDetailsEnable defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Enable.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status.operations[].manageModuleStreamsDetails.install[]

Back to ScheduledJob status

ScheduledJobOperationManageModuleStreamsDetailsInstall defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Install.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
profileName The name of a profile of the specified module stream. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status.operations[].manageModuleStreamsDetails.remove[]

Back to ScheduledJob status

ScheduledJobOperationManageModuleStreamsDetailsRemove defines nested fields for ScheduledJob.Operation.ManageModuleStreamsDetails.Remove.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
profileName The name of a profile of the specified module stream. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status.operations[].switchModuleStreamsDetails

Back to ScheduledJob status

ScheduledJobOperationSwitchModuleStreamsDetails defines nested fields for ScheduledJob.Operation.SwitchModuleStreamsDetails.

Field Description Type Required Default Enum
moduleName The name of a module. string Yes - -
softwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. string No - -
streamName The name of a stream of the specified module. string Yes - -

Status.status

Back to ScheduledJob 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 ScheduledJob 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 ScheduledJob 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 ScheduledJob status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

SoftwareSource

SoftwareSource is the Schema for the softwaresources API.

  • Plural: softwaresources
  • Scope: Namespaced
  • APIVersion: osmanagementhub.oracle.com/v1beta1
  • Sample: Sample (config/samples/osmanagementhub_v1beta1_softwaresource.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

SoftwareSourceSpec defines the desired state of SoftwareSource.

Field Description Type Required Default Enum
advancedRepoOptions Advanced repository options for the software source string No - -
archType The architecture type supported by the private software source. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source. string Yes - -
customSoftwareSourceFilter SoftwareSourceCustomSoftwareSourceFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter. object No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description for the software source. Avoid entering confidential information. string No - -
displayName User-friendly name for the software source. Does not have to be unique and you can change the name later. Avoid entering confidential information. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
gpgKeyUrl URI of the GPG key for this software source. string No - -
isAutoResolveDependencies Indicates whether the service should automatically resolve package dependencies when including specific packages in the software source. boolean No - -
isAutomaticallyUpdated Indicates whether the service should automatically update the custom software source to use the latest package versions available. The service reviews packages levels once a day. boolean No - -
isCreatedFromPackageList Indicates whether the service should create the software source from a list of packages provided by the user. boolean No - -
isGpgCheckEnabled Whether signature verification should be done for the software source boolean No - -
isLatestContentOnly Indicates whether the software source will include only the latest versions of content from vendor software sources, while accounting for other constraints set in the custom or versioned custom software source (such as a package list or filters). * For a module filter that does not specify a stream, this will include all available streams, and within each stream only the latest version of packages. * For a module filter that does specify a stream, this will include only the latest version of packages for the specified stream. * For a package filter that does not specify a version, this will include only the latest available version of the package. * For a package filter that does specify a version, this will include only the specified version of the package (the isLatestContentOnly attribute is ignored). * For a package list, this will include only the specified version of packages and modules in the list (the isLatestContentOnly attribute is ignored). boolean No - -
isMirrorSyncAllowed Whether this software source can be synced to a management station boolean No - -
isSslVerifyEnabled Whether SSL validation needs to be turned on boolean No - -
jsonData - string No - -
originSoftwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vendor software source in the root compartment that is being replicated. string No - -
osFamily The OS family for the private software source. string No - -
packages A property used for compatibility only. It doesn't provide a complete list of packages. See AddPackagesToSoftwareSourceDetails for providing the list of packages used to create the software source when isCreatedFromPackageList is set to true. list[string] No - -
softwareSourceSubType The creation type of a software source. string No - -
softwareSourceType - string No - -
softwareSourceVersion The version to assign to this custom software source. string No - -
url URL for the private software source. string No - -
vendorSoftwareSources List of vendor software sources. list[object] No - -

Spec.customSoftwareSourceFilter

Back to SoftwareSource spec

SoftwareSourceCustomSoftwareSourceFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.

Field Description Type Required Default Enum
moduleStreamProfileFilters The list of module stream/profile filters. list[object] No - -
packageFilters The list of package filters. list[object] No - -
packageGroupFilters The list of group filters. list[object] No - -

Spec.customSoftwareSourceFilter.moduleStreamProfileFilters[]

Back to SoftwareSource spec

SoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.ModuleStreamProfileFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
moduleName Module name. string Yes - -
profileName Profile name. string No - -
streamName Stream name. string No - -

Spec.customSoftwareSourceFilter.packageFilters[]

Back to SoftwareSource spec

SoftwareSourceCustomSoftwareSourceFilterPackageFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.PackageFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
packageName The package name. string No - -
packageNamePattern The package name pattern. string No - -
packageVersion The package version, which is denoted by 'version-release', or 'epoch:version-release'. string No - -

Spec.customSoftwareSourceFilter.packageGroupFilters[]

Back to SoftwareSource spec

SoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.PackageGroupFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
packageGroups List of package group names. list[string] No - -

Spec.vendorSoftwareSources[]

Back to SoftwareSource spec

SoftwareSourceVendorSoftwareSource defines nested fields for SoftwareSource.VendorSoftwareSource.

Field Description Type Required Default Enum
displayName User-friendly name. string Yes - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. string Yes - -

Status

SoftwareSourceStatus defines the observed state of SoftwareSource.

Field Description Type Required Default Enum
advancedRepoOptions Advanced repository options for the software source string No - -
archType The architecture type supported by the software source. string No - -
availability Availability of the software source (for non-OCI environments). string No - -
availabilityAtOci Availability of the software source (for OCI environments). string No - -
checksumType The yum repository checksum type used by this software source. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source. string No - -
customSoftwareSourceFilter SoftwareSourceCustomSoftwareSourceFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter. object No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description User-specified description for the software source. string No - -
displayName User-friendly name for the software source. string No - -
freeformTags 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
gpgKeyFingerprint Fingerprint of the GPG key for this software source. string No - -
gpgKeyId ID of the GPG key for this software source. string No - -
gpgKeyUrl URI of the GPG key for this software source. string No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the software source. string No - -
isAutoResolveDependencies Indicates whether the service should automatically resolve package dependencies when including specific packages in the software source. boolean No - -
isAutomaticallyUpdated Indicates whether the service should automatically update the custom software source to use the latest package versions available. The service reviews packages levels once a day. boolean No - -
isCreatedFromPackageList Indicates whether the service should create the software source from a list of packages provided by the user. boolean No - -
isGpgCheckEnabled Whether signature verification should be done for the software source boolean No - -
isLatestContentOnly Indicates whether the software source will include only the latest versions of content from vendor software sources, while accounting for other constraints set in the custom or versioned custom software source (such as a package list or filters). * For a module filter that does not specify a stream, this will include all available streams, and within each stream only the latest version of packages. * For a module filter that does specify a stream, this will include only the latest version of packages for the specified stream. * For a package filter that does not specify a version, this will include only the latest available version of the package. * For a package filter that does specify a version, this will include only the specified version of the package (the isLatestContentOnly attribute is ignored). * For a package list, this will include only the specified version of packages and modules in the list (the isLatestContentOnly attribute is ignored). boolean No - -
isMandatoryForAutonomousLinux Indicates whether the software source is required for the Autonomous Linux service. boolean No - -
isMirrorSyncAllowed Whether this software source can be synced to a management station boolean No - -
isSslVerifyEnabled Whether SSL validation needs to be turned on boolean No - -
jsonData - string No - -
lifecycleState The current state of the software source. string No - -
originSoftwareSourceId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the vendor software source in the root compartment. This property applies only to replicated vendor software sources. string No - -
osFamily The OS family of the software source. string No - -
packageCount Number of packages the software source contains. integer (int64) No - -
packages The packages in the software source. list[string] No - -
repoId The repository ID for the software source. string No - -
size The size of the software source in bytes (B). number No - -
softwareSourceSubType Identifies how the custom software source was created. string No - -
softwareSourceType - string No - -
softwareSourceVersion The version to assign to this custom software source. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The date and time the software source was created (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeMetadataUpdated The date and time the metadata for this software source was last updated (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
timeUpdated The date and time the software source was updated (in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) format). string No - -
url URL for the repository. For vendor software sources, this is the URL to the regional yum server. For custom software sources, this is 'custom/'. string No - -
vendorName Name of the vendor providing the software source. string No - -
vendorSoftwareSources List of vendor software sources that are used for the basis of the custom software source. list[object] No - -

Status.customSoftwareSourceFilter

Back to SoftwareSource status

SoftwareSourceCustomSoftwareSourceFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.

Field Description Type Required Default Enum
moduleStreamProfileFilters The list of module stream/profile filters. list[object] No - -
packageFilters The list of package filters. list[object] No - -
packageGroupFilters The list of group filters. list[object] No - -

Status.customSoftwareSourceFilter.moduleStreamProfileFilters[]

Back to SoftwareSource status

SoftwareSourceCustomSoftwareSourceFilterModuleStreamProfileFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.ModuleStreamProfileFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
moduleName Module name. string Yes - -
profileName Profile name. string No - -
streamName Stream name. string No - -

Status.customSoftwareSourceFilter.packageFilters[]

Back to SoftwareSource status

SoftwareSourceCustomSoftwareSourceFilterPackageFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.PackageFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
packageName The package name. string No - -
packageNamePattern The package name pattern. string No - -
packageVersion The package version, which is denoted by 'version-release', or 'epoch:version-release'. string No - -

Status.customSoftwareSourceFilter.packageGroupFilters[]

Back to SoftwareSource status

SoftwareSourceCustomSoftwareSourceFilterPackageGroupFilter defines nested fields for SoftwareSource.CustomSoftwareSourceFilter.PackageGroupFilter.

Field Description Type Required Default Enum
filterType The type of the filter. string Yes - -
packageGroups List of package group names. list[string] No - -

Status.status

Back to SoftwareSource 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 SoftwareSource 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 SoftwareSource 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 SoftwareSource status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.vendorSoftwareSources[]

Back to SoftwareSource status

SoftwareSourceVendorSoftwareSource defines nested fields for SoftwareSource.VendorSoftwareSource.

Field Description Type Required Default Enum
displayName User-friendly name. string Yes - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. string Yes - -