oracle.oci.oci_vulnerability_scanning_host_scan_recipe – Manage a HostScanRecipe resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_vulnerability_scanning_host_scan_recipe.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a HostScanRecipe resource in Oracle Cloud Infrastructure

  • For state=present, creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
agent_settings
dictionary
Required for create using state=present.
This parameter is updatable.
agent_configuration
dictionary
cis_benchmark_settings
dictionary
Applicable when vendor is 'OCI'
scan_level
string
    Choices:
  • NONE
  • LIGHT
  • MEDIUM
  • STRICT
The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
Applicable when vendor is 'OCI'
endpoint_protection_settings
dictionary
Applicable when vendor is 'OCI'
scan_level
string
    Choices:
  • NONE
  • STANDARD
The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
Applicable when vendor is 'OCI'
should_un_install
boolean
    Choices:
  • no
  • yes
Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
Required when vendor is 'QUALYS'
vault_secret_id
string
Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license.
Required when vendor is 'QUALYS'
vendor
string / required
    Choices:
  • QUALYS
  • OCI
Vendor to use for the host scan agent.
vendor_type
string
    Choices:
  • OCI
  • QUALYS
Vendor to use for the host scan agent.
scan_level
string / required
    Choices:
  • NONE
  • STANDARD
The scan level
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
application_settings
dictionary
This parameter is updatable.
application_scan_recurrence
string / required
Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=<weekday>;INTERVAL=1 - This weekly scan on the specified weekday (e.g. Sunday) FREQ=WEEKLY;WKST=<weekday>;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. Sunday) FREQ=MONTHLY;WKST=<weekday>;INTERVAL=1 - This monthly scan on the specified weekday (e.g. Sunday, starting from the next such weekday based on the time of setting creation)
folders_to_scan
list / elements=dictionary / required
List of folders selected for scanning
folder
string / required
Folder to be scanned in the corresponding operating system
operatingsystem
string / required
    Choices:
  • LINUX
  • WINDOWS
Operating system type
is_enabled
boolean / required
    Choices:
  • no
  • yes
Enable or disable application scan
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
host_scan_recipe_id
string
unique HostScanRecipe identifier
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
port_settings
dictionary
Required for create using state=present.
This parameter is updatable.
scan_level
string / required
    Choices:
  • NONE
  • LIGHT
  • STANDARD
The scan level
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
schedule
dictionary
Required for create using state=present.
This parameter is updatable.
day_of_week
string
    Choices:
  • SUNDAY
  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
Day of week the scheduled scan occurs (not applicable for DAILY type)
type
string / required
    Choices:
  • DAILY
  • WEEKLY
How often the scan occurs
state
string
    Choices:
  • present ←
  • absent
The state of the HostScanRecipe.
Use state=present to create or update a HostScanRecipe.
Use state=absent to delete a HostScanRecipe.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create host_scan_recipe
  oci_vulnerability_scanning_host_scan_recipe:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    port_settings:
      # required
      scan_level: NONE
    agent_settings:
      # required
      scan_level: NONE

      # optional
      agent_configuration:
        # required
        vault_secret_id: "ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx"
        should_un_install: true
        vendor: QUALYS

        # optional
        vendor_type: OCI
    schedule:
      # required
      type: DAILY

      # optional
      day_of_week: SUNDAY

    # optional
    display_name: display_name_example
    application_settings:
      # required
      application_scan_recurrence: application_scan_recurrence_example
      is_enabled: true
      folders_to_scan:
      - # required
        operatingsystem: LINUX
        folder: folder_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update host_scan_recipe
  oci_vulnerability_scanning_host_scan_recipe:
    # required
    host_scan_recipe_id: "ocid1.hostscanrecipe.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    port_settings:
      # required
      scan_level: NONE
    agent_settings:
      # required
      scan_level: NONE

      # optional
      agent_configuration:
        # required
        vault_secret_id: "ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx"
        should_un_install: true
        vendor: QUALYS

        # optional
        vendor_type: OCI
    application_settings:
      # required
      application_scan_recurrence: application_scan_recurrence_example
      is_enabled: true
      folders_to_scan:
      - # required
        operatingsystem: LINUX
        folder: folder_example
    schedule:
      # required
      type: DAILY

      # optional
      day_of_week: SUNDAY
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update host_scan_recipe using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_vulnerability_scanning_host_scan_recipe:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    port_settings:
      # required
      scan_level: NONE
    agent_settings:
      # required
      scan_level: NONE

      # optional
      agent_configuration:
        # required
        vault_secret_id: "ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx"
        should_un_install: true
        vendor: QUALYS

        # optional
        vendor_type: OCI
    application_settings:
      # required
      application_scan_recurrence: application_scan_recurrence_example
      is_enabled: true
      folders_to_scan:
      - # required
        operatingsystem: LINUX
        folder: folder_example
    schedule:
      # required
      type: DAILY

      # optional
      day_of_week: SUNDAY
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete host_scan_recipe
  oci_vulnerability_scanning_host_scan_recipe:
    # required
    host_scan_recipe_id: "ocid1.hostscanrecipe.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete host_scan_recipe using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_vulnerability_scanning_host_scan_recipe:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
host_scan_recipe
complex
on success
Details of the HostScanRecipe resource acted upon by the current operation

Sample:
{'agent_settings': {'agent_configuration': {'cis_benchmark_settings': {'scan_level': 'NONE'}, 'endpoint_protection_settings': {'scan_level': 'NONE'}, 'should_un_install': True, 'vault_secret_id': 'ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx', 'vendor': 'OCI', 'vendor_type': 'OCI'}, 'scan_level': 'NONE'}, 'application_settings': {'application_scan_recurrence': 'application_scan_recurrence_example', 'folders_to_scan': [{'folder': 'folder_example', 'operatingsystem': 'LINUX'}], 'is_enabled': True}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'port_settings': {'scan_level': 'NONE'}, 'schedule': {'day_of_week': 'SUNDAY', 'type': 'DAILY'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
agent_settings
complex
on success

   
agent_configuration
complex
on success

     
cis_benchmark_settings
complex
on success

       
scan_level
string
on success
The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.

Sample:
NONE
     
endpoint_protection_settings
complex
on success

       
scan_level
string
on success
The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.

Sample:
NONE
     
should_un_install
boolean
on success
Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.

Sample:
True
     
vault_secret_id
string
on success
Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license.

Sample:
ocid1.vaultsecret.oc1..xxxxxxEXAMPLExxxxxx
     
vendor
string
on success
Vendor to use for the host scan agent.

Sample:
OCI
     
vendor_type
string
on success
Vendor to use for the host scan agent.

Sample:
OCI
   
scan_level
string
on success
The scan level

Sample:
NONE
 
application_settings
complex
on success

   
application_scan_recurrence
string
on success
Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=<weekday>;INTERVAL=1 - This weekly scan on the specified weekday (e.g. Sunday) FREQ=WEEKLY;WKST=<weekday>;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. Sunday) FREQ=MONTHLY;WKST=<weekday>;INTERVAL=1 - This monthly scan on the specified weekday (e.g. Sunday, starting from the next such weekday based on the time of setting creation)

Sample:
application_scan_recurrence_example
   
folders_to_scan
complex
on success
List of folders selected for scanning

     
folder
string
on success
Folder to be scanned in the corresponding operating system

Sample:
folder_example
     
operatingsystem
string
on success
Operating system type

Sample:
LINUX
   
is_enabled
boolean
on success
Enable or disable application scan

Sample:
True
 
compartment_id
string
on success
Compartment ID of the scan recipe

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Recipe identifier, which can be renamed

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
Unique identifier of the config that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the config.

Sample:
CREATING
 
port_settings
complex
on success

   
scan_level
string
on success
The scan level

Sample:
NONE
 
schedule
complex
on success

   
day_of_week
string
on success
Day of week the scheduled scan occurs (not applicable for DAILY type)

Sample:
SUNDAY
   
type
string
on success
How often the scan occurs

Sample:
DAILY
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
Date and time the recipe was created, format as described in RFC 3339

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Date and time the recipe was last updated, format as described in RFC 3339

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)