Oracle Linux Virtualization Manager Record

GET POST/api/2.0/fo/auth/olvm/

Create, update, list and delete Oracle Linux Virtualization Manager (OLVM) records for compliance scans (using PA).

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={action}

Required String 

Specify create, update, delete (using POST) or list (using GET or POST). See List Auth Records for type

ids={value}

Required to update or delete record Integer 

Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated.

title={value}

Required to create record, optional to update record String 

A title for the record. The title must be unique. 

OLVM

ssl_verify_with_host={1|0}

Optional  Boolean 

SSL verification. Set to 1, if you want to verify the servers certificate is valid and trusted.

hosts={value}

Required if ssl_verify=1 String 

A list of FQDNs for all host IP addresses on which a custom SSL certificate signed by a trusted root CA is installed.

port={value}

Optional Integer 

The port number that the OLVM record instance.

Login credentials

login_type={basic|vault}

Required String

The login type is basic by default. You can choose vault (for vault based authentication). Set to vault if a third party vault is used to retrieve the password.

For vault based authentication, vault parameters need to be provided in the record.

username={value}

Required String  The user account to be used for authentication to the OLVM database.

password={value}

Required String  The password corresponding to the user account defined in the record for authentication. 

Vault

vault_type={value}

Required Integer 

The third party vault to be used to  retrieve the password for login.

vault_id={value}

Required Integer 

The vault ID from where you want to retrieve the password.

{vault parameters}

Required Integer 

Vault specific parameters required depend on the vault type you have selected. See Vault Parameters

Target Hosts

ips={value}

Required to create record Integer

The IP address(es) the server will log into using the record’s credentials. Multiple entries are comma separated.

Sample - Create OLVM RecordSample - Create OLVM Record

API request

curl -s -S -H 'X-Requested-With:curl' -u "<username>:<password>" -d "action=create&title=olvm&login_type=basic&username=<username>&password=<password>&port=443" "<qualys_base_url>/api/2.0/fo/auth/olvm/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
  <RESPONSE>
    <DATETIME>2026-03-27T13:10:32Z</DATETIME>
    <BATCH_LIST>
      <BATCH>
        <TEXT>Successfully Created</TEXT>
        <ID_SET>
          <ID>8419776</ID>
        </ID_SET>
      </BATCH>
    </BATCH_LIST>
  </RESPONSE>
</BATCH_RETURN>

Sample - Update OLVM RecordSample - Update OLVM Record

API request

curl -s -S -H 'X-Requested-With:curl' -u "<username>:<password>" \
-d "action=update&ids=8419776&title=olvm&username=<username>&password=<password> \
"<qualys_base_url>/api/2.0/fo/auth/olvm/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
  <RESPONSE>
    <DATETIME>2026-03-27T13:11:55Z</DATETIME>
    <BATCH_LIST>
      <BATCH>
        <TEXT>Successfully Updated</TEXT>
        <ID_SET>
          <ID>8419776</ID>
        </ID_SET>
      </BATCH>
    </BATCH_LIST>
  </RESPONSE>
</BATCH_RETURN>

Sample - Delete OLVM RecordSample - Delete OLVM Record

API request

curl -s -S -H 'X-Requested-With:curl' -u "<username>:<password>" -d "action=delete&ids=8393421" "<qualys_base_url>/api/2.0/fo/auth/olvm/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE BATCH_RETURN SYSTEM "<qualys_base_url>/api/2.0/batch_return.dtd">
<BATCH_RETURN>
  <RESPONSE>
    <DATETIME>2026-03-27T13:10:02Z</DATETIME>
    <BATCH_LIST>
      <BATCH>
        <TEXT>Successfully Deleted</TEXT>
        <ID_SET>
          <ID>8393421</ID>
        </ID_SET>
      </BATCH>
    </BATCH_LIST>
  </RESPONSE>
</BATCH_RETURN>

Sample - List OLVM RecordsSample - List OLVM Records

API request

curl -s -S -H 'X-Requested-With:curl' -u "<username>:<password>" -d "action=list" "<qualys_base_url>/api/2.0/fo/auth/olvm/"

XML output

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_OLVM_LIST_OUTPUT SYSTEM "<qualys_base_url>/api/2.0/fo/auth/olvm/auth_olvm_list_output.dtd">
<AUTH_OLVM_LIST_OUTPUT>
  <RESPONSE>
    <DATETIME>2026-03-27T13:06:50Z</DATETIME>
    <AUTH_OLVM_LIST>
      <AUTH_OLVM>
        <ID>8360487</ID>
        <TITLE><![CDATA[olvm]]></TITLE>
        <USERNAME><![CDATA[admin@internal]]></USERNAME>
        <IP_SET>
          <IP>10.10.10.100</IP>
        </IP_SET>
        <PORT><![CDATA[443]]></PORT>
        <LOGIN_TYPE><![CDATA[basic]]></LOGIN_TYPE>
        <NETWORK_ID>0</NETWORK_ID>
        <CREATED>
          <DATETIME>2026-03-24T05:57:37Z</DATETIME>
          <BY>rstec_rs</BY>
        </CREATED>
        <LAST_MODIFIED>
          <DATETIME>2026-03-24T05:57:37Z</DATETIME>
        </LAST_MODIFIED>
      </AUTH_OLVM>
      <AUTH_OLVM>
        <ID>8369474</ID>
        <TITLE><![CDATA[OLVM_Test_Update_RM]]></TITLE>
        <USERNAME><![CDATA[admin@internal]]></USERNAME>
        <IP_SET>
          <IP_RANGE>1.1.1.1-1.1.1.100</IP_RANGE>
        </IP_SET>
        <PORT><![CDATA[443]]></PORT>
        <SSL_VERIFY_WITH_HOST><![CDATA[0]]></SSL_VERIFY_WITH_HOST>
        <LOGIN_TYPE><![CDATA[basic]]></LOGIN_TYPE>
        <NETWORK_ID>0</NETWORK_ID>
        <CREATED>
          <DATETIME>2026-03-24T10:05:41Z</DATETIME>
          <BY>rstec_rs</BY>
        </CREATED>
        <LAST_MODIFIED>
          <DATETIME>2026-03-24T10:44:22Z</DATETIME>
        </LAST_MODIFIED>
      </AUTH_OLVM>
      <AUTH_OLVM>
        <ID>8370573</ID>
        <TITLE><![CDATA[OLVM_KK]]></TITLE>
        <USERNAME><![CDATA[root]]></USERNAME>
        <IP_SET>
          <IP>10.10.10.100</IP>
        </IP_SET>
        <PORT><![CDATA[443]]></PORT>
        <SSL_VERIFY_WITH_HOST><![CDATA[0]]></SSL_VERIFY_WITH_HOST>
        <LOGIN_TYPE><![CDATA[basic]]></LOGIN_TYPE>
        <NETWORK_ID>0</NETWORK_ID>
        <CREATED>
          <DATETIME>2026-03-24T11:32:24Z</DATETIME>
          <BY>rstec_rs</BY>
        </CREATED>
        <LAST_MODIFIED>
          <DATETIME>2026-03-24T11:32:24Z</DATETIME>
        </LAST_MODIFIED>
      </AUTH_OLVM>
    </AUTH_OLVM_LIST>
  </RESPONSE>
</AUTH_OLVM_LIST_OUTPUT>

DTDs for Authentication Type "OLVM"

<platform API server>/api/2.0/batch_return.dtd

<platform API server>/api/2.0/fo/auth/olvm/auth_olvm_list_output.dtd

 

 

success Thank you! We're glad to hear that this topic was useful.
success We appreciate your feedback. We'll work to make this topic better for you in the future.