Oracle Linux Documentation

https://docs.oracle.com/en/operating-systems/oracle-linux/
Admin
Oracle Linux Documentation is a comprehensive guide covering Oracle Linux distributions, kernel...
Tokens:3,493,959
Snippets:38,731
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Libreswan

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/vpn/vpn-ConfiguringaVPNbyUsingLibreswan.html

Initializes the Libreswan setup.

```bash
sudo ipsec setup start
```

--------------------------------

### Install and enable mcstrans

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/selinux/selinux_enabling_the_mcstrans_service.html

Installs the mcstrans package and starts the service immediately.

```bash
sudo dnf install -y mcstrans
sudo enable --now mcstrans
```

--------------------------------

### Install and Enable Watchdog Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-config_vm_watchdog.html

Commands to install the watchdog package and start the service on the guest OS.

```bash
sudo dnf install watchdog
sudo systemctl enable --now watchdog.service
```

--------------------------------

### Configure Boot Loader Options

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-ConfiguringtheBootLoader.html

Example of specifying installation repository and Kickstart file locations via boot command line parameters.

```text
inst.repo=nfs:nfs.example.com:/ISOs/OL10/full_image.iso \
inst.ks=nfs:nfs.example.com:/kickstart/OL10/server-ks.cfg ip=dhcp
```

--------------------------------

### Setup and Start Quorum Device Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/availability/availability-InstallingandEnablingaQuorumDevice.html

Configure the host to use the net model and start the quorum device service.

```bash
sudo pcs qdev setup model net --enable --start
```

--------------------------------

### Retrieve Workflow Jobs List

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/swagger.json

Make a GET request to this resource to retrieve the list of workflow jobs. The response includes count, pagination links, and a list of workflow job records.

```bash
curl -k --user "admin:password" https://localhost:8080/api/v2/workflow_jobs/
```

--------------------------------

### Get Workflow Job Labels

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/swagger.json

Retrieves a list of labels associated with a specific workflow job. Supports searching, pagination, and sorting.

```APIDOC
## GET /api/v2/workflow_jobs/{id}/labels/

### Description
Make a GET request to this resource to retrieve a list of labels associated with the selected workflow job. The response includes count, pagination links, and a list of label records.

### Method
GET

### Endpoint
/api/v2/workflow_jobs/{id}/labels/

### Parameters
#### Query Parameters
- **search** (string) - Optional - A search term to filter labels.
- **page** (integer) - Optional - The page number for paginated results.
- **page_size** (integer) - Optional - The number of results to return per page.

### Response
#### Success Response (200)
- **count** (integer) - The total number of labels found.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.
- **results** (array) - A list of label objects.

Each label object contains:
- **id** (integer) - Database ID for this label.
- **type** (choice) - Data type for this label.
- **url** (string) - URL for this label.
- **related** (object) - Data structure with URLs of related resources.
- **summary_fields** (object) - Data structure with name/description for related resources.
- **created** (datetime) - Timestamp when this label was created.
- **modified** (datetime) - Timestamp when this label was last modified.
- **name** (string) - Name of this label.
- **organization** (id) - Organization this label belongs to.

### Response Example
```json
{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "type": "some_type",
            "url": "/api/v2/labels/1/",
            "related": {},
            "summary_fields": {},
            "created": "2023-01-01T10:00:00Z",
            "modified": "2023-01-01T10:00:00Z",
            "name": "example_label",
            "organization": 1
        }
    ]
}
```

### Sorting
Use the `order_by` query string parameter to specify the sort order. Prefix with `-` for reverse order. Multiple fields can be comma-separated.
Example: `?order_by=name` or `?order_by=-name,id`

### Pagination
Use `page_size` to set results per page and `page` to select a specific page. The `next` and `previous` links in the response will automatically set these parameters.
Example: `?page_size=100&page=2`

### Searching
Use the `search` query string parameter for case-insensitive search across text fields.
Example: `?search=findme`
Search across related fields: `?related__search=findme` (Added in Ansible Tower 3.1.0)
```

--------------------------------

### Get Started with REST API

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/op-api-v2-job_templates-id-notification_templates_started-get.html

This section covers the basics of interacting with the REST API, including installation, authentication, and making requests.

```APIDOC
## REST API Quick Start

This section guides you through using the REST API.

### Installing and Using cURL

Learn how to install and use cURL for making API requests.

### Authenticating

Understand the authentication mechanisms for accessing the API.

### Accessing the REST API

Details on how to access the various API endpoints.

### Sending Requests

Information on constructing and sending requests to the API.

### Ordering and Sorting

How to order and sort the results returned by the API.

### Searching Text Fields

Techniques for searching within text fields of resources.

### Filtering Results Using Operators

Using operators to filter the data returned by the API.

### Limiting Response Results Using Pagination

Implementing pagination to manage large result sets.

### Accessing Resources Using Named URLs

Using named URLs to access specific resources.
```

--------------------------------

### Define Preinstallation Options

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-AbouttheKickstartConfigurationFile.html

Use the %pre section to execute scripts or download files before the installation begins.

```kickstart
%pre
%include http://server-ip-address/scripts/config-partitions
wget -q -O- http://server-ip-address/scripts/package-list > /tmp/package-list
%end
```

--------------------------------

### Example Ping GET Response

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/op-api-v2-ping-get.html

This is an example JSON response for the /api/v2/ping/ endpoint. It includes details about the active node, high availability status, installation UUID, instance groups, instances, and the software version.

```json
{
    "active_node":"awx_1",
    "ha":false,
    "install_uuid":"00000000-0000-0000-0000-000000000000",
    "instance_groups":[
    ],
    "instances":[
    ],
    "version":"23.7.0"
}

```

--------------------------------

### Example: Create Snapper Configuration for Root Filesystem

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/btrfs/btrfs-UsingtheSnapperUtilityWithBtrfsSubvolumes.html

An example of setting up the Snapper configuration for the root (/) Btrfs filesystem.

```bash
sudo snapper -c root_config create-config -f btrfs /

```

--------------------------------

### Install kubeadm-upgrade package

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/kubernetes/kubernetes_install_upgrade.html

Install the required upgrade package on the master node before starting the upgrade process.

```bash
# yum install kubeadm-upgrade
```

--------------------------------

### Standard Build Process Example

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/dtrace-guide/dtrace-ref-StaticallyDefinedTracingofUserApplications.html

Illustrates a typical build process for an application using multiple source files and object files.

```makefile
src1.o: src1.c
    gcc -c src1.c

src2.o: src2.c
    gcc -c src2.c

myserv: src1.o src2.o
    gcc -o myserv src1.o src2.o
```

--------------------------------

### Install SCAP Packages

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/oscap/oscap-SCAPPackages.html

Install the core OpenSCAP utilities and security guide packages using dnf.

```bash
sudo dnf install openscap openscap-utils scap-security-guide
```

--------------------------------

### List virt-install help

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-CreatingaNewVirtualMachine.html

Displays the help menu for the virt-install command.

```bash
virt-install --help
```

--------------------------------

### Create Oracle Linux 9 VM with Kickstart

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-CreatingaNewVirtualMachine.html

Automates the installation of a VM using a URL installation tree and a kickstart configuration file.

```bash
virt-install \
    --graphics vnc \
    --name ol9-guest-demo1 --memory 2048 --vcpus 2 --disk size=160 \
    --os-variant ol9.0 --location http://example.com/OS-install \
    --initrd-inject /home/uniquename/ks.cfg --extra-args="inst.ks=file:/ks.cfg console=tty0 console=ttyS0,115200n8"
```

--------------------------------

### Install Kubernetes HA Packages

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/kubernetes/kube_ha.html

Install the necessary Kubernetes and HA setup packages on all master nodes.

```bash
# **yum install kubeadm kubelet kubectl kubeadm-ha-setup**
```

--------------------------------

### Import a QCOW2 disk image with virt-install

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-CreatingaNewVirtualMachine.html

Creates a VM named ol8-guest-demo using an existing disk image. Specifying the os-variant is recommended to ensure optimal performance.

```bash
virt-install \
    --name ol8-guest-demo --memory 2048 --vcpus 2 \
    --os-variant ol8.0 --import \
    --disk /home/uniquename/backup/disk.qcow2
```

--------------------------------

### Start and Enable Kdump Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/boot/monitoring-InstallingKdump.html

Enable the kdump service to start automatically on system boot and start it immediately. This ensures Kdump is active after installation and configuration.

```bash
sudo systemctl enable --now kdump.service

```

--------------------------------

### Example dnf installation output

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/software-management/sfw-mgmt-InstallSoftwareonEnterpriseLinux.html

This output shows the dependency resolution and confirmation prompt encountered during a package installation.

```text
Last metadata expiration check: 1:38:46 ago on Mon 14 Apr 2025 13:47:07 BST.
Dependencies resolved.
=======================================================================================================
 Package                Architecture    Version                       Repository                  Size
=======================================================================================================
Reinstalling:
 dnf-automatic          noarch          4.14.0-17.0.1.el9             ol9_baseos_latest           51 k

Transaction Summary
=======================================================================================================

Total download size: 51 k
Installed size: 54 k
Is this ok [y/N]
```

--------------------------------

### Specify Local Kickstart File Location

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-StartingtheKickstartInstallation.html

Use the inst.ks boot option to point the installer to a specific configuration file on local media.

```text
inst.ks=cdrom:/dev/sbd1/tmp/ks.cfg
```

--------------------------------

### Get Notification Templates for Started Workflow Job

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/op-api-v2-workflow_job_templates-id-notification_templates_started-get.html

Retrieves the notification templates associated with a workflow job that has started.

```APIDOC
## GET /api/v2/workflow_job_templates/{id}/notification_templates_started

### Description
Retrieves the notification templates associated with a workflow job that has started.

### Method
GET

### Endpoint
/api/v2/workflow_job_templates/{id}/notification_templates_started

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the workflow job template.
```

--------------------------------

### Install Initiator Tools

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/ceph-storage/ceph-luminous-UsingCephStorageforOracleLinux.html

Install required iSCSI and multipath packages on the client.

```bash
yum install iscsi-initiator-utils device-mapper-multipath
```

--------------------------------

### Example: Create thin pool and logical volume

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/stordev/stordev-UsingThinlyProvisionedLogicalVolumes.html

Demonstrates creating a 1GB thin pool and a 2GB thinly-provisioned logical volume.

```bash
sudo lvcreate --size 1g --thin myvg/mytp
```

```bash
sudo lvcreate --virtualsize 2g --thin myvg/mytp --name mytv
```

--------------------------------

### Configure Network Settings in Postinstallation

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-AbouttheKickstartConfigurationFile.html

Ensure network resolution is available during postinstallation by providing a temporary resolv.conf file.

```kickstart
%post
wget -q -O- http://192.168.1.100/scripts/resolv.conf > /etc/resolv.conf
%include http://instsvr.example.com/scripts/post-config
.
.
.
%end
```

--------------------------------

### Install Private Automation Hub with local database

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/install-private-hub2.3/awx-InstallingOracleLinuxAutomationManager.html

Executes the installation playbook for a single-node setup with local database credentials.

```bash
ansible-playbook single-node-install.yml -i hosts -e "olpah_admin_password=<admin_password> olpah_db_password=<db_password>"
```

--------------------------------

### Configure disk options for virt-install

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-CreatingaNewVirtualMachine.html

Examples of different disk configuration parameters for virtual machine creation.

```bash
--disk size=[capacity size in gigabytes]
```

```bash
--disk /storage-pool-path/volume-path,size=#
```

```bash
--disk=/iso-images/ol8-dvd.iso,device=cdrom
```

--------------------------------

### Copy Installation Kernel and Ram-Disk

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-ConfiguringPXEBootLoading.html

Copy the installation kernel (vmlinuz) and ram-disk image (initrd.img) from the NFS share to the UEFI boot directory. These files are used to start the Oracle Linux installation.

```bash
sudo cp /var/nfs-exports/ISOs/ol10/vmlinuz -O /var/lib/tftpboot/efi/vmlinuz
sudo cp /var/nfs-exports/ISOs/ol10/initrd.img /var/lib/tftpboot/efi/initrd.img

```

--------------------------------

### Configure and Start Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/systemd/SystemdMngCgroupsV2.html

Commands to make the script executable and enable the service.

```bash
sudo chmod +x /usr/lib/systemd/generate_load.sh
```

```bash
sudo systemctl enable myservice1 --now
```

--------------------------------

### Create Working Directory and Files

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/user-guide-private-hub2.3/awx_builder.html

Set up the necessary directory and files for configuring a custom execution environment using format 2.

```bash
mkdir ~/builder-utility 
cd ~/builder-utility
touch ansible.cfg execution-environment.yml requirements.yml requirements.txt bindep.txt
```

--------------------------------

### Get Notification Templates for Started System Jobs

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/olam-api-cli2.3/op-api-v2-system_job_templates-id-notification_templates_started-get.html

Retrieves a list of notification templates for system jobs that have started. Supports pagination and searching.

```APIDOC
## GET /system/job_templates/{id}/notification_templates/started

### Description
Retrieves a list of notification templates for system jobs that have started. This endpoint supports filtering and pagination.

### Method
GET

### Endpoint
/system/job_templates/{id}/notification_templates/started

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the system job template.

#### Query Parameters
- **page** (integer) - Optional - A page number within the paginated result set.
- **page_size** (integer) - Optional - Number of results to return per page. Defaults to 100.
- **search** (string) - Optional - A case-insensitive search term to filter results.

### Response
#### Success Response (200)
- **results** (array) - A list of notification templates.
- **count** (integer) - The total number of results available.
- **next** (string) - URL for the next page of results.
- **previous** (string) - URL for the previous page of results.

#### Response Example
{
  "results": [
    {
      "id": 1,
      "type": "email",
      "template": "Job {{job.name}} started."
    }
  ],
  "count": 1,
  "next": null,
  "previous": null
}
```

--------------------------------

### Enable SSH Root Login in Postinstallation

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/install/install-AbouttheKickstartConfigurationFile.html

Use the %post section to modify system configuration files after the installation is complete.

```kickstart
%post
echo "PermitRootLogin yes" > /etc/ssh/sshd_config.d/01-permitrootlogin.conf
%end
```

--------------------------------

### Start the NMB Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/samba/services_concept.html

Starts the nmb systemd service, responsible for NetBIOS name resolution and network browsing. Ensure the 'samba' package is installed.

```bash
sudo systemctl start nmb.service
```

--------------------------------

### Prepare Hosts File

Source: https://docs.oracle.com/en/operating-systems/oracle-linux-automation-manager/2/install-private-hub2.3/awx-InstallingOracleLinuxAutomationManager.html

Navigates to the working directory and creates the hosts file.

```bash
cd ~/single_node
cp hosts.singlenode.example hosts
```

--------------------------------

### Start the Winbind Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/samba/services_concept.html

Starts the winbind systemd service, used for resolving Active Directory users and groups. Install the 'samba-winbind' package to use this service. If setting up as a domain member, start this before the 'smb' service.

```bash
sudo systemctl start winbind.service
```

--------------------------------

### Get help for a specific corelens module

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/drgn/corelens_command_reference.html

Use the -h option after specifying a module with -M to learn more about its functionality. For example, to get help for the 'dentrycache' module.

```bash
corelens -M module -h
```

--------------------------------

### Enable and start the Watchdog service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/boot/boot-ConfigWatchdogServ.html

Use systemctl to enable the service to start at boot and initiate it immediately.

```bash
sudo systemctl enable --now watchdog
```

--------------------------------

### Start KVM Guest

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/kvm-user/kvm-network-topicgroup.html

Launch a KVM guest domain by name.

```bash
sudo virsh start GuestName
```

--------------------------------

### Start the SMB Service

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/samba/services_concept.html

Starts the smb systemd service, which provides file sharing and printing services using the SMB protocol. Ensure the 'samba' package is installed.

```bash
sudo systemctl start smb.service
```

--------------------------------

### Example Output of mkfs Utilities

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/10/fsadmin/fsadmin-about_file_systems.html

This is an example of the output you might see when listing local file system creation utilities. The actual output depends on the installed packages.

```text
/sbin/mkfs.btrfs
/sbin/mkfs.cramfs
/sbin/mkfs.exfat
/sbin/mkfs.ext2
/sbin/mkfs.ext3
/sbin/mkfs.ext4
/sbin/mkfs.fat
/sbin/mkfs.minix
/sbin/mkfs.msdos
/sbin/mkfs.ocfs2
/sbin/mkfs.udf
/sbin/mkfs.vfat
/sbin/mkfs.xfs
/sbin/mkfs.xmem
```

--------------------------------

### Measure Program Runtime with proc:::start and proc:::exit

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/dtrace-v2-guide/dtrace-ref-procProvider.html

This example utilizes the proc:::start and proc:::exit probes to measure the duration of program execution. It records the start time and calculates the elapsed time upon program termination, then aggregates the results using quantize.

```dtrace
proc:::start
{
  self->start = timestamp;
}

proc:::exit
/self->start/
{
  @[execname] = quantize(timestamp - self->start);
  self->start = 0;
}

```

--------------------------------

### Define a Containerfile

Source: https://docs.oracle.com/en/operating-systems/oracle-linux/podman/buildah.html

Example content for a Containerfile based on Oracle Linux 9 that installs the httpd package.

```dockerfile
# This image is based on the latest Oracle Linux 9 image
FROM container-registry.oracle.com/os/oraclelinux:9

# Install OS updates and the httpd software package
RUN echo "Updating all Oracle packages"; dnf -y update; dnf -y clean all
RUN echo "Installing the httpd software package"; dnf -y install httpd && dnf -y clean all

# Expose the default httpd server port 80
EXPOSE 80

# Run the httpd server
CMD ["/usr/sbin/httpd", "-DFOREGROUND"]
```
Tokens:
Raw