Was this topic helpful?
For API version information, refer to the API Version History section.
List VM option profiles in the user's account.
Permissions - All users with VM scan permissions will be able to list option profiles.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=list |
Required |
String |
Specify action to list VM option profiles. |
|
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
{parameters} |
Optional |
Integer |
All option profiles are fetched if no parameters are given. To fetch a specific option profile, provide the “id” or “title” parameter with the option profile id or title of interest. Optionally, you can filter the results by using optional parameters |
Click here to view list of optional parameters.
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET"action=list" "http://<qualys_base_url>/api/2.0/fo/subscription/option_profile/vm/"XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE OPTION_PROFILES SYSTEM "http://<qualys_base_url>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd">
<OPTION_PROFILES>
<OPTION_PROFILE>
<BASIC_INFO>
<ID>51451401</ID>
<GROUP_NAME><![CDATA[user op - 1]]></GROUP_NAME>
<GROUP_TYPE>user</GROUP_TYPE>
<USER_ID><![CDATA[John smith (jsmith_ap)]]></USER_ID>
<UNIT_ID>0</UNIT_ID>
<SUBSCRIPTION_ID>10421401</SUBSCRIPTION_ID>
<IS_DEFAULT>0</IS_DEFAULT>
<IS_GLOBAL>1</IS_GLOBAL>
<IS_OFFLINE_SYNCABLE>1</IS_OFFLINE_SYNCABLE>
<UPDATE_DATE>2018-04-10T13:39:41Z</UPDATE_DATE>
</BASIC_INFO>
<SCAN>
<PORTS>
<TCP_PORTS>
<TCP_PORTS_TYPE>standard</TCP_PORTS_TYPE>
<TCP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1024</ADDITIONAL_PORTS>
</TCP_PORTS_ADDITIONAL>
<THREE_WAY_HANDSHAKE>1</THREE_WAY_HANDSHAKE>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_TYPE>light</UDP_PORTS_TYPE>
<UDP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>8080</ADDITIONAL_PORTS>
</UDP_PORTS_ADDITIONAL>
</UDP_PORTS>
<AUTHORITATIVE_OPTION>1</AUTHORITATIVE_OPTION>
</PORTS>
<SCAN_DEAD_HOSTS>1</SCAN_DEAD_HOSTS>
<CLOSE_VULNERABILITIES>
<HAS_CLOSE_VULNERABILITIES>1</HAS_CLOSE_VULNERABILITIES>
<HOST_NOT_FOUND_ALIVE>10</HOST_NOT_FOUND_ALIVE>
</CLOSE_VULNERABILITIES>
<PURGE_OLD_HOST_OS_CHANGED>1</PURGE_OLD_HOST_OS_CHANGED>
<PERFORMANCE>
<PARALLEL_SCALING>1</PARALLEL_SCALING>
<OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE>
<HOSTS_TO_SCAN>
<EXTERNAL_SCANNERS>10</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>30</SCANNER_APPLIANCES>
</HOSTS_TO_SCAN>
<PROCESSES_TO_RUN>
<TOTAL_PROCESSES>10</TOTAL_PROCESSES>
<HTTP_PROCESSES>10</HTTP_PROCESSES>
</PROCESSES_TO_RUN>
<PACKET_DELAY>Medium</PACKET_DELAY>
<PORT_SCANNING_AND_HOST_DISCOVERY>Normal</PORT_SCANNING_AND_HOST_DISCOVERY>
</PERFORMANCE>
<LOAD_BALANCER_DETECTION>1</LOAD_BALANCER_DETECTION>
<PASSWORD_BRUTE_FORCING>
<SYSTEM>
<HAS_SYSTEM>1</HAS_SYSTEM>
<SYSTEM_LEVEL>Standard</SYSTEM_LEVEL>
</SYSTEM>
<CUSTOM_LIST>
<CUSTOM>
<ID>1001</ID>
<TITLE><![CDATA[ftp - 1]]></TITLE>
<TYPE>FTP</TYPE>
<LOGIN_PASSWORD><![CDATA[L:Guest,P:temp]]></LOGIN_PASSWORD>
</CUSTOM>
<CUSTOM>
<ID>1002</ID>
<TITLE><![CDATA[ssh - 1]]></TITLE>
<TYPE>SSH</TYPE>
<LOGIN_PASSWORD><![CDATA[L:Guest,P:temp]]></LOGIN_PASSWORD>
</CUSTOM>
<CUSTOM>
<ID>1003</ID>
<TITLE><![CDATA[window - 1]]></TITLE>
<TYPE>Windows</TYPE>
<LOGIN_PASSWORD><![CDATA[L:Guest,P:temp]]></LOGIN_PASSWORD>
</CUSTOM>
</CUSTOM_LIST>
</PASSWORD_BRUTE_FORCING>
<VULNERABILITY_DETECTION>
<COMPLETE><![CDATA[complete]]></COMPLETE>
<DETECTION_INCLUDE>
<BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS>
<OVAL_CHECKS>1</OVAL_CHECKS>
</DETECTION_INCLUDE>
</VULNERABILITY_DETECTION>
<AUTHENTICATION><![CDATA[Windows,Unix,Oracle,Oracle Listener,SNMP,VMware,DB2,HTTP,MySQL]]></AUTHENTICATION>
<AUTHENTICATION_LEAST_PRIVILEGE><![CDATA[Unix]]></AUTHENTICATION_LEAST_PRIVILEGE>
<ADDL_CERT_DETECTION>1</ADDL_CERT_DETECTION>
<DISSOLVABLE_AGENT>
<DISSOLVABLE_AGENT_ENABLE>1</DISSOLVABLE_AGENT_ENABLE>
<WINDOWS_SHARE_ENUMERATION_ENABLE>1</WINDOWS_SHARE_ENUMERATION_ENABLE>
</DISSOLVABLE_AGENT>
<LITE_OS_SCAN>1</LITE_OS_SCAN>
<CUSTOM_HTTP_HEADER>
<VALUE>sdfdsf</VALUE>
<DEFINITION_KEY>abc</DEFINITION_KEY>
<DEFINITION_VALUE>xyz</DEFINITION_VALUE>
</CUSTOM_HTTP_HEADER>
<SYSTEM_AUTH_RECORD>
<INCLUDE_SYSTEM_AUTH>
<ON_DUPLICATE_USE_SYSTEM_AUTH>1</ON_DUPLICATE_USE_SYSTEM_AUTH>
</INCLUDE_SYSTEM_AUTH>
</SYSTEM_AUTH_RECORD>
</SCAN>
<MAP>
<BASIC_INFO_GATHERING_ON>all</BASIC_INFO_GATHERING_ON>
<TCP_PORTS>
<TCP_PORTS_STANDARD_SCAN>1</TCP_PORTS_STANDARD_SCAN>
<TCP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>2</ADDITIONAL_PORTS>
</TCP_PORTS_ADDITIONAL>
</TCP_PORTS>
<UDP_PORTS>
<UDP_PORTS_STANDARD_SCAN>1</UDP_PORTS_STANDARD_SCAN>
<UDP_PORTS_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>9</ADDITIONAL_PORTS>
</UDP_PORTS_ADDITIONAL>
</UDP_PORTS>
<MAP_OPTIONS>
<PERFORM_LIVE_HOST_SWEEP>1</PERFORM_LIVE_HOST_SWEEP>
<DISABLE_DNS_TRAFFIC>1</DISABLE_DNS_TRAFFIC>
</MAP_OPTIONS>
<MAP_PERFORMANCE>
<OVERALL_PERFORMANCE>Custom</OVERALL_PERFORMANCE>
<MAP_PARALLEL>
<EXTERNAL_SCANNERS>10</EXTERNAL_SCANNERS>
<SCANNER_APPLIANCES>12</SCANNER_APPLIANCES>
<NETBLOCK_SIZE>8192 IPs</NETBLOCK_SIZE>
</MAP_PARALLEL>
<PACKET_DELAY>Medium</PACKET_DELAY>
</MAP_PERFORMANCE>
<MAP_AUTHENTICATION>VMware</MAP_AUTHENTICATION>
</MAP>
<ADDITIONAL>
<HOST_DISCOVERY>
<TCP_PORTS>
<STANDARD_SCAN>1</STANDARD_SCAN>
<TCP_ADDITIONAL>
<HAS_ADDITIONAL>1</HAS_ADDITIONAL>
<ADDITIONAL_PORTS>1024</ADDITIONAL_PORTS>
</TCP_ADDITIONAL>
</TCP_PORTS>
<UDP_PORTS>
<CUSTOM_PORT><![CDATA[69,111]]></CUSTOM_PORT>
</UDP_PORTS>
<ICMP>1</ICMP>
</HOST_DISCOVERY>
<BLOCK_RESOURCES>
<WATCHGUARD_DEFAULT_BLOCKED_PORTS>1</WATCHGUARD_DEFAULT_BLOCKED_PORTS>
<ALL_REGISTERED_IPS>1</ALL_REGISTERED_IPS>
</BLOCK_RESOURCES>
<PACKET_OPTIONS>
<IGNORE_FIREWALL_GENERATED_TCP_RST>1</IGNORE_FIREWALL_GENERATED_TCP_RST>
<IGNORE_ALL_TCP_RST>1</IGNORE_ALL_TCP_RST>
<IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>1</IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>
<NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>1</NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>
</PACKET_OPTIONS>
</ADDITIONAL>
</OPTION_PROFILE>
</OPTION_PROFILES><platform API server>/api/2.0/fo/subscription/option_profile/option_profile_info.dtd
List VM option profiles in the user's account.
Permissions - All users with VM scan permissions will be able to list option profiles.
Input ParametersInput Parameters
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=list |
Required |
String |
Specify action to list VM option profiles. |
|
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
{parameters} |
Optional |
Integer |
All option profiles are fetched if no parameters are given. To fetch a specific option profile, provide the “id” or “title” parameter with the option profile id or title of interest. Optionally, you can filter the results by using optional parameters |
Click here to view the list of optional parameters.
Sample - List VM Option ProfileSample - List VM Option Profile
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X GET"action=list" "action=list&title=Option_profile_vCenter_scan_disconnected_esxi"
"https://<qualys_base_url>/api/3.0/fo/subscription/option_profile/vm/"XML output
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE OPTION_PROFILES SYSTEM "https:// <qualys_base_url>/api/3.0/fo/subscription/option_profile/option_ profile_info.dtd"> <OPTION_PROFILES> <OPTION_PROFILE> <BASIC_INFO> <ID>2633919</ID> <GROUP_NAME> <![CDATA[Option_profile_vCenter_scan_disconnected_esxi]]> </GROUP_NAME> <GROUP_TYPE>user</GROUP_TYPE> <USER_ID> <![CDATA[John Manager (agms_nb)]]> </USER_ID> <UNIT_ID>0</UNIT_ID> <SUBSCRIPTION_ID>194334</SUBSCRIPTION_ID> <IS_DEFAULT>0</IS_DEFAULT> <IS_GLOBAL>0</IS_GLOBAL> <IS_OFFLINE_SYNCABLE>0</IS_OFFLINE_SYNCABLE> <UPDATE_DATE>2024-07-01T09:55:01Z</UPDATE_DATE> </BASIC_INFO> <SCAN> <PORTS> <TCP_PORTS> <TCP_PORTS_TYPE>none</TCP_PORTS_TYPE> <THREE_WAY_HANDSHAKE>0</THREE_WAY_HANDSHAKE> </TCP_PORTS> <UDP_PORTS> <UDP_PORTS_TYPE>none</UDP_PORTS_TYPE> </UDP_PORTS> <AUTHORITATIVE_OPTION>0</AUTHORITATIVE_OPTION> </PORTS> <SCAN_DEAD_HOSTS>0</SCAN_DEAD_HOSTS> <PURGE_OLD_HOST_OS_CHANGED>0</PURGE_OLD_HOST_OS_CHANGED> <PERFORMANCE> <PARALLEL_SCALING>0</PARALLEL_SCALING> <OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE> <HOSTS_TO_SCAN> <EXTERNAL_SCANNERS>15</EXTERNAL_SCANNERS> <SCANNER_APPLIANCES>30</SCANNER_APPLIANCES> </HOSTS_TO_SCAN> <PROCESSES_TO_RUN> <TOTAL_PROCESSES>10</TOTAL_PROCESSES> <HTTP_PROCESSES>10</HTTP_PROCESSES> </PROCESSES_TO_RUN> <PACKET_DELAY>Medium</PACKET_DELAY> <PORT_SCANNING_AND_HOST_DISCOVERY>Normal </PORT_SCANNING_AND_HOST_DISCOVER Y> </PERFORMANCE> <LOAD_BALANCER_DETECTION>0</LOAD_BALANCER_DETECTION> <VULNERABILITY_DETECTION> <COMPLETE> <![CDATA[complete]]> </COMPLETE> <DETECTION_INCLUDE> <BASIC_HOST_INFO_CHECKS>0</BASIC_HOST_INFO_CHECKS> <OVAL_CHECKS>0</OVAL_CHECKS> <QRDI_CHECKS>0</QRDI_CHECKS> </DETECTION_INCLUDE> </VULNERABILITY_DETECTION> <ADDL_CERT_DETECTION>0</ADDL_CERT_DETECTION> </SCAN> <MAP> <BASIC_INFO_GATHERING_ON>none</BASIC_INFO_GATHERING_ON> <MAP_OPTIONS> <PERFORM_LIVE_HOST_SWEEP>0</PERFORM_LIVE_HOST_SWEEP> <DISABLE_DNS_TRAFFIC>0</DISABLE_DNS_TRAFFIC> </MAP_OPTIONS> <MAP_PERFORMANCE> <OVERALL_PERFORMANCE>Normal</OVERALL_PERFORMANCE> <MAP_PARALLEL> <EXTERNAL_SCANNERS>6</EXTERNAL_SCANNERS> <SCANNER_APPLIANCES>8</SCANNER_APPLIANCES> <NETBLOCK_SIZE>16384 IPs</NETBLOCK_SIZE> </MAP_PARALLEL> <PACKET_DELAY>Minimum</PACKET_DELAY> </MAP_PERFORMANCE> <MAP_AUTHENTICATION>vCenter</MAP_AUTHENTICATION> <DISCONNECTED_ESXI>1</DISCONNECTED_ESXI> </MAP> <ADDITIONAL> <HOST_DISCOVERY> <TCP_PORTS> <STANDARD_SCAN>1</STANDARD_SCAN> </TCP_PORTS> <UDP_PORTS> <STANDARD_SCAN>1</STANDARD_SCAN> </UDP_PORTS> <ICMP>1</ICMP> </HOST_DISCOVERY> <PACKET_OPTIONS> <IGNORE_FIREWALL_GENERATED_TCP_RST>0</IGNORE_FIREWALL_GENERATED_TCP_RST> <IGNORE_ALL_TCP_RST>0</IGNORE_ALL_TCP_RST> <IGNORE_FIREWALL_GENERATED_TCP_SYN_ACK>0 </IGNORE_FIREWALL_GENERATED_TCP_S YN_ACK> <NOT_SEND_TCP_ACK_OR_SYN_ACK_DURING_HOST_DISCOVERY>0 </NOT_SEND_TCP_ACK_OR _SYN_ACK_DURING_HOST_DISCOVERY> </PACKET_OPTIONS> </ADDITIONAL> </OPTION_PROFILE> </OPTION_PROFILES>
<platform API server>/api/3.0/fo/subscription/option_profile/option_profile_info.dtd
The following table depicts the information about the different versions of this API along with the status:
| API Version | API Status | Release Date |
| /api/2.0/fo/subscription/option_profile/?action=list | To be deprecated | January 2025 |
| /api/3.0/fo/subscription/option_profile/?action=list | Active |
July 2024 |
Was this topic helpful?