Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. VulnerabilityScanning
  5. HostScanRecipe
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.VulnerabilityScanning.HostScanRecipe

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Host Scan Recipe resource in Oracle Cloud Infrastructure Vulnerability Scanning service.

Creates a new HostScanRecipe. A recipe determines the types of security issues that you want scanned, and how often to scan.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testHostScanRecipe = new oci.vulnerabilityscanning.HostScanRecipe("test_host_scan_recipe", {
    agentSettings: {
        scanLevel: hostScanRecipeAgentSettingsScanLevel,
        agentConfiguration: {
            vendor: hostScanRecipeAgentSettingsAgentConfigurationVendor,
            cisBenchmarkSettings: {
                scanLevel: hostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsScanLevel,
            },
            endpointProtectionSettings: {
                scanLevel: hostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsScanLevel,
            },
            shouldUnInstall: hostScanRecipeAgentSettingsAgentConfigurationShouldUnInstall,
            vaultSecretId: testSecret.id,
            vendorType: hostScanRecipeAgentSettingsAgentConfigurationVendorType,
        },
    },
    compartmentId: compartmentId,
    portSettings: {
        scanLevel: hostScanRecipePortSettingsScanLevel,
    },
    schedule: {
        type: hostScanRecipeScheduleType,
        dayOfWeek: hostScanRecipeScheduleDayOfWeek,
    },
    applicationSettings: {
        applicationScanRecurrence: hostScanRecipeApplicationSettingsApplicationScanRecurrence,
        foldersToScans: [{
            folder: hostScanRecipeApplicationSettingsFoldersToScanFolder,
            operatingsystem: hostScanRecipeApplicationSettingsFoldersToScanOperatingsystem,
        }],
        isEnabled: hostScanRecipeApplicationSettingsIsEnabled,
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    displayName: hostScanRecipeDisplayName,
    freeformTags: {
        "bar-key": "value",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_host_scan_recipe = oci.vulnerability_scanning.HostScanRecipe("test_host_scan_recipe",
    agent_settings={
        "scan_level": host_scan_recipe_agent_settings_scan_level,
        "agent_configuration": {
            "vendor": host_scan_recipe_agent_settings_agent_configuration_vendor,
            "cis_benchmark_settings": {
                "scan_level": host_scan_recipe_agent_settings_agent_configuration_cis_benchmark_settings_scan_level,
            },
            "endpoint_protection_settings": {
                "scan_level": host_scan_recipe_agent_settings_agent_configuration_endpoint_protection_settings_scan_level,
            },
            "should_un_install": host_scan_recipe_agent_settings_agent_configuration_should_un_install,
            "vault_secret_id": test_secret["id"],
            "vendor_type": host_scan_recipe_agent_settings_agent_configuration_vendor_type,
        },
    },
    compartment_id=compartment_id,
    port_settings={
        "scan_level": host_scan_recipe_port_settings_scan_level,
    },
    schedule={
        "type": host_scan_recipe_schedule_type,
        "day_of_week": host_scan_recipe_schedule_day_of_week,
    },
    application_settings={
        "application_scan_recurrence": host_scan_recipe_application_settings_application_scan_recurrence,
        "folders_to_scans": [{
            "folder": host_scan_recipe_application_settings_folders_to_scan_folder,
            "operatingsystem": host_scan_recipe_application_settings_folders_to_scan_operatingsystem,
        }],
        "is_enabled": host_scan_recipe_application_settings_is_enabled,
    },
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    display_name=host_scan_recipe_display_name,
    freeform_tags={
        "bar-key": "value",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/vulnerabilityscanning"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vulnerabilityscanning.NewHostScanRecipe(ctx, "test_host_scan_recipe", &vulnerabilityscanning.HostScanRecipeArgs{
			AgentSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsArgs{
				ScanLevel: pulumi.Any(hostScanRecipeAgentSettingsScanLevel),
				AgentConfiguration: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationArgs{
					Vendor: pulumi.Any(hostScanRecipeAgentSettingsAgentConfigurationVendor),
					CisBenchmarkSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs{
						ScanLevel: pulumi.Any(hostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsScanLevel),
					},
					EndpointProtectionSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs{
						ScanLevel: pulumi.Any(hostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsScanLevel),
					},
					ShouldUnInstall: pulumi.Any(hostScanRecipeAgentSettingsAgentConfigurationShouldUnInstall),
					VaultSecretId:   pulumi.Any(testSecret.Id),
					VendorType:      pulumi.Any(hostScanRecipeAgentSettingsAgentConfigurationVendorType),
				},
			},
			CompartmentId: pulumi.Any(compartmentId),
			PortSettings: &vulnerabilityscanning.HostScanRecipePortSettingsArgs{
				ScanLevel: pulumi.Any(hostScanRecipePortSettingsScanLevel),
			},
			Schedule: &vulnerabilityscanning.HostScanRecipeScheduleArgs{
				Type:      pulumi.Any(hostScanRecipeScheduleType),
				DayOfWeek: pulumi.Any(hostScanRecipeScheduleDayOfWeek),
			},
			ApplicationSettings: &vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs{
				ApplicationScanRecurrence: pulumi.Any(hostScanRecipeApplicationSettingsApplicationScanRecurrence),
				FoldersToScans: vulnerabilityscanning.HostScanRecipeApplicationSettingsFoldersToScanArray{
					&vulnerabilityscanning.HostScanRecipeApplicationSettingsFoldersToScanArgs{
						Folder:          pulumi.Any(hostScanRecipeApplicationSettingsFoldersToScanFolder),
						Operatingsystem: pulumi.Any(hostScanRecipeApplicationSettingsFoldersToScanOperatingsystem),
					},
				},
				IsEnabled: pulumi.Any(hostScanRecipeApplicationSettingsIsEnabled),
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			DisplayName: pulumi.Any(hostScanRecipeDisplayName),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testHostScanRecipe = new Oci.VulnerabilityScanning.HostScanRecipe("test_host_scan_recipe", new()
    {
        AgentSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsArgs
        {
            ScanLevel = hostScanRecipeAgentSettingsScanLevel,
            AgentConfiguration = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationArgs
            {
                Vendor = hostScanRecipeAgentSettingsAgentConfigurationVendor,
                CisBenchmarkSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs
                {
                    ScanLevel = hostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsScanLevel,
                },
                EndpointProtectionSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs
                {
                    ScanLevel = hostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsScanLevel,
                },
                ShouldUnInstall = hostScanRecipeAgentSettingsAgentConfigurationShouldUnInstall,
                VaultSecretId = testSecret.Id,
                VendorType = hostScanRecipeAgentSettingsAgentConfigurationVendorType,
            },
        },
        CompartmentId = compartmentId,
        PortSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipePortSettingsArgs
        {
            ScanLevel = hostScanRecipePortSettingsScanLevel,
        },
        Schedule = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeScheduleArgs
        {
            Type = hostScanRecipeScheduleType,
            DayOfWeek = hostScanRecipeScheduleDayOfWeek,
        },
        ApplicationSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeApplicationSettingsArgs
        {
            ApplicationScanRecurrence = hostScanRecipeApplicationSettingsApplicationScanRecurrence,
            FoldersToScans = new[]
            {
                new Oci.VulnerabilityScanning.Inputs.HostScanRecipeApplicationSettingsFoldersToScanArgs
                {
                    Folder = hostScanRecipeApplicationSettingsFoldersToScanFolder,
                    Operatingsystem = hostScanRecipeApplicationSettingsFoldersToScanOperatingsystem,
                },
            },
            IsEnabled = hostScanRecipeApplicationSettingsIsEnabled,
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        DisplayName = hostScanRecipeDisplayName,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.VulnerabilityScanning.HostScanRecipe;
import com.pulumi.oci.VulnerabilityScanning.HostScanRecipeArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeAgentSettingsArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeAgentSettingsAgentConfigurationArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipePortSettingsArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeScheduleArgs;
import com.pulumi.oci.VulnerabilityScanning.inputs.HostScanRecipeApplicationSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testHostScanRecipe = new HostScanRecipe("testHostScanRecipe", HostScanRecipeArgs.builder()
            .agentSettings(HostScanRecipeAgentSettingsArgs.builder()
                .scanLevel(hostScanRecipeAgentSettingsScanLevel)
                .agentConfiguration(HostScanRecipeAgentSettingsAgentConfigurationArgs.builder()
                    .vendor(hostScanRecipeAgentSettingsAgentConfigurationVendor)
                    .cisBenchmarkSettings(HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs.builder()
                        .scanLevel(hostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsScanLevel)
                        .build())
                    .endpointProtectionSettings(HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs.builder()
                        .scanLevel(hostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsScanLevel)
                        .build())
                    .shouldUnInstall(hostScanRecipeAgentSettingsAgentConfigurationShouldUnInstall)
                    .vaultSecretId(testSecret.id())
                    .vendorType(hostScanRecipeAgentSettingsAgentConfigurationVendorType)
                    .build())
                .build())
            .compartmentId(compartmentId)
            .portSettings(HostScanRecipePortSettingsArgs.builder()
                .scanLevel(hostScanRecipePortSettingsScanLevel)
                .build())
            .schedule(HostScanRecipeScheduleArgs.builder()
                .type(hostScanRecipeScheduleType)
                .dayOfWeek(hostScanRecipeScheduleDayOfWeek)
                .build())
            .applicationSettings(HostScanRecipeApplicationSettingsArgs.builder()
                .applicationScanRecurrence(hostScanRecipeApplicationSettingsApplicationScanRecurrence)
                .foldersToScans(HostScanRecipeApplicationSettingsFoldersToScanArgs.builder()
                    .folder(hostScanRecipeApplicationSettingsFoldersToScanFolder)
                    .operatingsystem(hostScanRecipeApplicationSettingsFoldersToScanOperatingsystem)
                    .build())
                .isEnabled(hostScanRecipeApplicationSettingsIsEnabled)
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .displayName(hostScanRecipeDisplayName)
            .freeformTags(Map.of("bar-key", "value"))
            .build());

    }
}
Copy
resources:
  testHostScanRecipe:
    type: oci:VulnerabilityScanning:HostScanRecipe
    name: test_host_scan_recipe
    properties:
      agentSettings:
        scanLevel: ${hostScanRecipeAgentSettingsScanLevel}
        agentConfiguration:
          vendor: ${hostScanRecipeAgentSettingsAgentConfigurationVendor}
          cisBenchmarkSettings:
            scanLevel: ${hostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsScanLevel}
          endpointProtectionSettings:
            scanLevel: ${hostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsScanLevel}
          shouldUnInstall: ${hostScanRecipeAgentSettingsAgentConfigurationShouldUnInstall}
          vaultSecretId: ${testSecret.id}
          vendorType: ${hostScanRecipeAgentSettingsAgentConfigurationVendorType}
      compartmentId: ${compartmentId}
      portSettings:
        scanLevel: ${hostScanRecipePortSettingsScanLevel}
      schedule:
        type: ${hostScanRecipeScheduleType}
        dayOfWeek: ${hostScanRecipeScheduleDayOfWeek}
      applicationSettings:
        applicationScanRecurrence: ${hostScanRecipeApplicationSettingsApplicationScanRecurrence}
        foldersToScans:
          - folder: ${hostScanRecipeApplicationSettingsFoldersToScanFolder}
            operatingsystem: ${hostScanRecipeApplicationSettingsFoldersToScanOperatingsystem}
        isEnabled: ${hostScanRecipeApplicationSettingsIsEnabled}
      definedTags:
        foo-namespace.bar-key: value
      displayName: ${hostScanRecipeDisplayName}
      freeformTags:
        bar-key: value
Copy

Create HostScanRecipe Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HostScanRecipe(name: string, args: HostScanRecipeArgs, opts?: CustomResourceOptions);
@overload
def HostScanRecipe(resource_name: str,
                   args: HostScanRecipeArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HostScanRecipe(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   agent_settings: Optional[_vulnerabilityscanning.HostScanRecipeAgentSettingsArgs] = None,
                   compartment_id: Optional[str] = None,
                   port_settings: Optional[_vulnerabilityscanning.HostScanRecipePortSettingsArgs] = None,
                   schedule: Optional[_vulnerabilityscanning.HostScanRecipeScheduleArgs] = None,
                   application_settings: Optional[_vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   display_name: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None)
func NewHostScanRecipe(ctx *Context, name string, args HostScanRecipeArgs, opts ...ResourceOption) (*HostScanRecipe, error)
public HostScanRecipe(string name, HostScanRecipeArgs args, CustomResourceOptions? opts = null)
public HostScanRecipe(String name, HostScanRecipeArgs args)
public HostScanRecipe(String name, HostScanRecipeArgs args, CustomResourceOptions options)

type: oci:VulnerabilityScanning:HostScanRecipe
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HostScanRecipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HostScanRecipeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HostScanRecipeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HostScanRecipeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HostScanRecipeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var hostScanRecipeResource = new Oci.VulnerabilityScanning.HostScanRecipe("hostScanRecipeResource", new()
{
    AgentSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsArgs
    {
        ScanLevel = "string",
        AgentConfiguration = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationArgs
        {
            Vendor = "string",
            CisBenchmarkSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs
            {
                ScanLevel = "string",
            },
            EndpointProtectionSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs
            {
                ScanLevel = "string",
            },
            ShouldUnInstall = false,
            VaultSecretId = "string",
            VendorType = "string",
        },
    },
    CompartmentId = "string",
    PortSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipePortSettingsArgs
    {
        ScanLevel = "string",
    },
    Schedule = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeScheduleArgs
    {
        Type = "string",
        DayOfWeek = "string",
    },
    ApplicationSettings = new Oci.VulnerabilityScanning.Inputs.HostScanRecipeApplicationSettingsArgs
    {
        ApplicationScanRecurrence = "string",
        FoldersToScans = new[]
        {
            new Oci.VulnerabilityScanning.Inputs.HostScanRecipeApplicationSettingsFoldersToScanArgs
            {
                Folder = "string",
                Operatingsystem = "string",
            },
        },
        IsEnabled = false,
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := VulnerabilityScanning.NewHostScanRecipe(ctx, "hostScanRecipeResource", &VulnerabilityScanning.HostScanRecipeArgs{
	AgentSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsArgs{
		ScanLevel: pulumi.String("string"),
		AgentConfiguration: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationArgs{
			Vendor: pulumi.String("string"),
			CisBenchmarkSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs{
				ScanLevel: pulumi.String("string"),
			},
			EndpointProtectionSettings: &vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs{
				ScanLevel: pulumi.String("string"),
			},
			ShouldUnInstall: pulumi.Bool(false),
			VaultSecretId:   pulumi.String("string"),
			VendorType:      pulumi.String("string"),
		},
	},
	CompartmentId: pulumi.String("string"),
	PortSettings: &vulnerabilityscanning.HostScanRecipePortSettingsArgs{
		ScanLevel: pulumi.String("string"),
	},
	Schedule: &vulnerabilityscanning.HostScanRecipeScheduleArgs{
		Type:      pulumi.String("string"),
		DayOfWeek: pulumi.String("string"),
	},
	ApplicationSettings: &vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs{
		ApplicationScanRecurrence: pulumi.String("string"),
		FoldersToScans: vulnerabilityscanning.HostScanRecipeApplicationSettingsFoldersToScanArray{
			&vulnerabilityscanning.HostScanRecipeApplicationSettingsFoldersToScanArgs{
				Folder:          pulumi.String("string"),
				Operatingsystem: pulumi.String("string"),
			},
		},
		IsEnabled: pulumi.Bool(false),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var hostScanRecipeResource = new HostScanRecipe("hostScanRecipeResource", HostScanRecipeArgs.builder()
    .agentSettings(HostScanRecipeAgentSettingsArgs.builder()
        .scanLevel("string")
        .agentConfiguration(HostScanRecipeAgentSettingsAgentConfigurationArgs.builder()
            .vendor("string")
            .cisBenchmarkSettings(HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs.builder()
                .scanLevel("string")
                .build())
            .endpointProtectionSettings(HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs.builder()
                .scanLevel("string")
                .build())
            .shouldUnInstall(false)
            .vaultSecretId("string")
            .vendorType("string")
            .build())
        .build())
    .compartmentId("string")
    .portSettings(HostScanRecipePortSettingsArgs.builder()
        .scanLevel("string")
        .build())
    .schedule(HostScanRecipeScheduleArgs.builder()
        .type("string")
        .dayOfWeek("string")
        .build())
    .applicationSettings(HostScanRecipeApplicationSettingsArgs.builder()
        .applicationScanRecurrence("string")
        .foldersToScans(HostScanRecipeApplicationSettingsFoldersToScanArgs.builder()
            .folder("string")
            .operatingsystem("string")
            .build())
        .isEnabled(false)
        .build())
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .build());
Copy
host_scan_recipe_resource = oci.vulnerability_scanning.HostScanRecipe("hostScanRecipeResource",
    agent_settings={
        "scan_level": "string",
        "agent_configuration": {
            "vendor": "string",
            "cis_benchmark_settings": {
                "scan_level": "string",
            },
            "endpoint_protection_settings": {
                "scan_level": "string",
            },
            "should_un_install": False,
            "vault_secret_id": "string",
            "vendor_type": "string",
        },
    },
    compartment_id="string",
    port_settings={
        "scan_level": "string",
    },
    schedule={
        "type": "string",
        "day_of_week": "string",
    },
    application_settings={
        "application_scan_recurrence": "string",
        "folders_to_scans": [{
            "folder": "string",
            "operatingsystem": "string",
        }],
        "is_enabled": False,
    },
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    })
Copy
const hostScanRecipeResource = new oci.vulnerabilityscanning.HostScanRecipe("hostScanRecipeResource", {
    agentSettings: {
        scanLevel: "string",
        agentConfiguration: {
            vendor: "string",
            cisBenchmarkSettings: {
                scanLevel: "string",
            },
            endpointProtectionSettings: {
                scanLevel: "string",
            },
            shouldUnInstall: false,
            vaultSecretId: "string",
            vendorType: "string",
        },
    },
    compartmentId: "string",
    portSettings: {
        scanLevel: "string",
    },
    schedule: {
        type: "string",
        dayOfWeek: "string",
    },
    applicationSettings: {
        applicationScanRecurrence: "string",
        foldersToScans: [{
            folder: "string",
            operatingsystem: "string",
        }],
        isEnabled: false,
    },
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
});
Copy
type: oci:VulnerabilityScanning:HostScanRecipe
properties:
    agentSettings:
        agentConfiguration:
            cisBenchmarkSettings:
                scanLevel: string
            endpointProtectionSettings:
                scanLevel: string
            shouldUnInstall: false
            vaultSecretId: string
            vendor: string
            vendorType: string
        scanLevel: string
    applicationSettings:
        applicationScanRecurrence: string
        foldersToScans:
            - folder: string
              operatingsystem: string
        isEnabled: false
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    portSettings:
        scanLevel: string
    schedule:
        dayOfWeek: string
        type: string
Copy

HostScanRecipe Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HostScanRecipe resource accepts the following input properties:

AgentSettings This property is required. HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
CompartmentId This property is required. string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
PortSettings This property is required. HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
Schedule This property is required. HostScanRecipeSchedule
(Updatable) A scanning schedule
ApplicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
AgentSettings This property is required. HostScanRecipeAgentSettingsArgs
(Updatable) Agent scan settings for a host scan
CompartmentId This property is required. string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
PortSettings This property is required. HostScanRecipePortSettingsArgs
(Updatable) Port scan settings for a host scan
Schedule This property is required. HostScanRecipeScheduleArgs
(Updatable) A scanning schedule
ApplicationSettings HostScanRecipeApplicationSettingsArgs
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
agentSettings This property is required. HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
compartmentId This property is required. String
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
portSettings This property is required. HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
schedule This property is required. HostScanRecipeSchedule
(Updatable) A scanning schedule
applicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
agentSettings This property is required. HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
compartmentId This property is required. string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
portSettings This property is required. HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
schedule This property is required. HostScanRecipeSchedule
(Updatable) A scanning schedule
applicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
agent_settings This property is required. vulnerabilityscanning.HostScanRecipeAgentSettingsArgs
(Updatable) Agent scan settings for a host scan
compartment_id This property is required. str
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
port_settings This property is required. vulnerabilityscanning.HostScanRecipePortSettingsArgs
(Updatable) Port scan settings for a host scan
schedule This property is required. vulnerabilityscanning.HostScanRecipeScheduleArgs
(Updatable) A scanning schedule
application_settings vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
agentSettings This property is required. Property Map
(Updatable) Agent scan settings for a host scan
compartmentId This property is required. String
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
portSettings This property is required. Property Map
(Updatable) Port scan settings for a host scan
schedule This property is required. Property Map
(Updatable) A scanning schedule
applicationSettings Property Map
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Outputs

All input properties are implicitly available as output properties. Additionally, the HostScanRecipe resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of the config.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Date and time the recipe was created, format as described in RFC 3339
TimeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
Id string
The provider-assigned unique ID for this managed resource.
State string
The current state of the config.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Date and time the recipe was created, format as described in RFC 3339
TimeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of the config.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Date and time the recipe was created, format as described in RFC 3339
timeUpdated String
Date and time the recipe was last updated, format as described in RFC 3339
id string
The provider-assigned unique ID for this managed resource.
state string
The current state of the config.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
Date and time the recipe was created, format as described in RFC 3339
timeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
id str
The provider-assigned unique ID for this managed resource.
state str
The current state of the config.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
Date and time the recipe was created, format as described in RFC 3339
time_updated str
Date and time the recipe was last updated, format as described in RFC 3339
id String
The provider-assigned unique ID for this managed resource.
state String
The current state of the config.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Date and time the recipe was created, format as described in RFC 3339
timeUpdated String
Date and time the recipe was last updated, format as described in RFC 3339

Look up Existing HostScanRecipe Resource

Get an existing HostScanRecipe resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HostScanRecipeState, opts?: CustomResourceOptions): HostScanRecipe
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_settings: Optional[_vulnerabilityscanning.HostScanRecipeAgentSettingsArgs] = None,
        application_settings: Optional[_vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        port_settings: Optional[_vulnerabilityscanning.HostScanRecipePortSettingsArgs] = None,
        schedule: Optional[_vulnerabilityscanning.HostScanRecipeScheduleArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> HostScanRecipe
func GetHostScanRecipe(ctx *Context, name string, id IDInput, state *HostScanRecipeState, opts ...ResourceOption) (*HostScanRecipe, error)
public static HostScanRecipe Get(string name, Input<string> id, HostScanRecipeState? state, CustomResourceOptions? opts = null)
public static HostScanRecipe get(String name, Output<String> id, HostScanRecipeState state, CustomResourceOptions options)
resources:  _:    type: oci:VulnerabilityScanning:HostScanRecipe    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AgentSettings HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
ApplicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
CompartmentId string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
FreeformTags Dictionary<string, string>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
PortSettings HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
Schedule HostScanRecipeSchedule
(Updatable) A scanning schedule
State string
The current state of the config.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Date and time the recipe was created, format as described in RFC 3339
TimeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
AgentSettings HostScanRecipeAgentSettingsArgs
(Updatable) Agent scan settings for a host scan
ApplicationSettings HostScanRecipeApplicationSettingsArgs
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
CompartmentId string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
FreeformTags map[string]string
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
PortSettings HostScanRecipePortSettingsArgs
(Updatable) Port scan settings for a host scan
Schedule HostScanRecipeScheduleArgs
(Updatable) A scanning schedule
State string
The current state of the config.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
Date and time the recipe was created, format as described in RFC 3339
TimeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
agentSettings HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
applicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
compartmentId String
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags Map<String,String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
portSettings HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
schedule HostScanRecipeSchedule
(Updatable) A scanning schedule
state String
The current state of the config.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Date and time the recipe was created, format as described in RFC 3339
timeUpdated String
Date and time the recipe was last updated, format as described in RFC 3339
agentSettings HostScanRecipeAgentSettings
(Updatable) Agent scan settings for a host scan
applicationSettings HostScanRecipeApplicationSettings
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
compartmentId string
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags {[key: string]: string}
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
portSettings HostScanRecipePortSettings
(Updatable) Port scan settings for a host scan
schedule HostScanRecipeSchedule
(Updatable) A scanning schedule
state string
The current state of the config.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
Date and time the recipe was created, format as described in RFC 3339
timeUpdated string
Date and time the recipe was last updated, format as described in RFC 3339
agent_settings vulnerabilityscanning.HostScanRecipeAgentSettingsArgs
(Updatable) Agent scan settings for a host scan
application_settings vulnerabilityscanning.HostScanRecipeApplicationSettingsArgs
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
compartment_id str
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeform_tags Mapping[str, str]
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
port_settings vulnerabilityscanning.HostScanRecipePortSettingsArgs
(Updatable) Port scan settings for a host scan
schedule vulnerabilityscanning.HostScanRecipeScheduleArgs
(Updatable) A scanning schedule
state str
The current state of the config.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
Date and time the recipe was created, format as described in RFC 3339
time_updated str
Date and time the recipe was last updated, format as described in RFC 3339
agentSettings Property Map
(Updatable) Agent scan settings for a host scan
applicationSettings Property Map
(Updatable) Agent scan settings for an application scan (as a part of a host scan)
compartmentId String
(Updatable) Compartment ID of the scanning config. If no individual hosts are specified, all hosts in this compartment are scanned
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String
(Updatable) Recipe identifier, which can be renamed. If not present, it will be auto-generated. Avoid entering confidential information.
freeformTags Map<String>
(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
portSettings Property Map
(Updatable) Port scan settings for a host scan
schedule Property Map
(Updatable) A scanning schedule
state String
The current state of the config.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
Date and time the recipe was created, format as described in RFC 3339
timeUpdated String
Date and time the recipe was last updated, format as described in RFC 3339

Supporting Types

HostScanRecipeAgentSettings
, HostScanRecipeAgentSettingsArgs

ScanLevel This property is required. string
(Updatable) The scan level
AgentConfiguration HostScanRecipeAgentSettingsAgentConfiguration
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
ScanLevel This property is required. string
(Updatable) The scan level
AgentConfiguration HostScanRecipeAgentSettingsAgentConfiguration
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
scanLevel This property is required. String
(Updatable) The scan level
agentConfiguration HostScanRecipeAgentSettingsAgentConfiguration
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
scanLevel This property is required. string
(Updatable) The scan level
agentConfiguration HostScanRecipeAgentSettingsAgentConfiguration
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
scan_level This property is required. str
(Updatable) The scan level
agent_configuration vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfiguration
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
scanLevel This property is required. String
(Updatable) The scan level
agentConfiguration Property Map
(Updatable) Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.

HostScanRecipeAgentSettingsAgentConfiguration
, HostScanRecipeAgentSettingsAgentConfigurationArgs

Vendor This property is required. string
(Updatable) Vendor to use for the host scan agent.
CisBenchmarkSettings HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
EndpointProtectionSettings HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
(Updatable) Endpoint Protection scan settings for a host scan
ShouldUnInstall bool
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
VaultSecretId string
(Updatable) 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.
VendorType string
(Updatable) Vendor to use for the host scan agent.
Vendor This property is required. string
(Updatable) Vendor to use for the host scan agent.
CisBenchmarkSettings HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
EndpointProtectionSettings HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
(Updatable) Endpoint Protection scan settings for a host scan
ShouldUnInstall bool
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
VaultSecretId string
(Updatable) 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.
VendorType string
(Updatable) Vendor to use for the host scan agent.
vendor This property is required. String
(Updatable) Vendor to use for the host scan agent.
cisBenchmarkSettings HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
endpointProtectionSettings HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
(Updatable) Endpoint Protection scan settings for a host scan
shouldUnInstall Boolean
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
vaultSecretId String
(Updatable) 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.
vendorType String
(Updatable) Vendor to use for the host scan agent.
vendor This property is required. string
(Updatable) Vendor to use for the host scan agent.
cisBenchmarkSettings HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
endpointProtectionSettings HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
(Updatable) Endpoint Protection scan settings for a host scan
shouldUnInstall boolean
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
vaultSecretId string
(Updatable) 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.
vendorType string
(Updatable) Vendor to use for the host scan agent.
vendor This property is required. str
(Updatable) Vendor to use for the host scan agent.
cis_benchmark_settings vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
endpoint_protection_settings vulnerabilityscanning.HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
(Updatable) Endpoint Protection scan settings for a host scan
should_un_install bool
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
vault_secret_id str
(Updatable) 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.
vendor_type str
(Updatable) Vendor to use for the host scan agent.
vendor This property is required. String
(Updatable) Vendor to use for the host scan agent.
cisBenchmarkSettings Property Map
(Updatable) CIS (Center for Internet Security) Benchmark scan settings for a host scan
endpointProtectionSettings Property Map
(Updatable) Endpoint Protection scan settings for a host scan
shouldUnInstall Boolean
(Updatable) Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
vaultSecretId String
(Updatable) 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.
vendorType String
(Updatable) Vendor to use for the host scan agent.

HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettings
, HostScanRecipeAgentSettingsAgentConfigurationCisBenchmarkSettingsArgs

ScanLevel string
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
ScanLevel string
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
scanLevel String
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
scanLevel string
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
scan_level str
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.
scanLevel String
(Updatable) The level of strictness to apply for CIS Benchmarks. Use 'NONE' to disable CIS Benchmark checks entirely.

HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettings
, HostScanRecipeAgentSettingsAgentConfigurationEndpointProtectionSettingsArgs

ScanLevel string
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
ScanLevel string
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
scanLevel String
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
scanLevel string
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
scan_level str
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.
scanLevel String
(Updatable) The scan level. Use 'NONE' to disable Endpoint Protection checks entirely.

HostScanRecipeApplicationSettings
, HostScanRecipeApplicationSettingsArgs

ApplicationScanRecurrence This property is required. string
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
FoldersToScans This property is required. List<HostScanRecipeApplicationSettingsFoldersToScan>
(Updatable) List of folders selected for scanning
IsEnabled This property is required. bool
(Updatable) Enable or disable application scan
ApplicationScanRecurrence This property is required. string
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
FoldersToScans This property is required. []HostScanRecipeApplicationSettingsFoldersToScan
(Updatable) List of folders selected for scanning
IsEnabled This property is required. bool
(Updatable) Enable or disable application scan
applicationScanRecurrence This property is required. String
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
foldersToScans This property is required. List<HostScanRecipeApplicationSettingsFoldersToScan>
(Updatable) List of folders selected for scanning
isEnabled This property is required. Boolean
(Updatable) Enable or disable application scan
applicationScanRecurrence This property is required. string
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
foldersToScans This property is required. HostScanRecipeApplicationSettingsFoldersToScan[]
(Updatable) List of folders selected for scanning
isEnabled This property is required. boolean
(Updatable) Enable or disable application scan
application_scan_recurrence This property is required. str
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
folders_to_scans This property is required. Sequence[vulnerabilityscanning.HostScanRecipeApplicationSettingsFoldersToScan]
(Updatable) List of folders selected for scanning
is_enabled This property is required. bool
(Updatable) Enable or disable application scan
applicationScanRecurrence This property is required. String
(Updatable) Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=;INTERVAL=1 - This weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=WEEKLY;WKST=;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. SU for Sunday) FREQ=MONTHLY;WKST=;INTERVAL=1 - This monthly scan on the specified weekday (e.g. SU for Sunday, starting from the next such weekday based on the time of setting creation)
foldersToScans This property is required. List<Property Map>
(Updatable) List of folders selected for scanning
isEnabled This property is required. Boolean
(Updatable) Enable or disable application scan

HostScanRecipeApplicationSettingsFoldersToScan
, HostScanRecipeApplicationSettingsFoldersToScanArgs

Folder This property is required. string
(Updatable) Folder to be scanned in the corresponding operating system
Operatingsystem This property is required. string
(Updatable) Operating system type
Folder This property is required. string
(Updatable) Folder to be scanned in the corresponding operating system
Operatingsystem This property is required. string
(Updatable) Operating system type
folder This property is required. String
(Updatable) Folder to be scanned in the corresponding operating system
operatingsystem This property is required. String
(Updatable) Operating system type
folder This property is required. string
(Updatable) Folder to be scanned in the corresponding operating system
operatingsystem This property is required. string
(Updatable) Operating system type
folder This property is required. str
(Updatable) Folder to be scanned in the corresponding operating system
operatingsystem This property is required. str
(Updatable) Operating system type
folder This property is required. String
(Updatable) Folder to be scanned in the corresponding operating system
operatingsystem This property is required. String
(Updatable) Operating system type

HostScanRecipePortSettings
, HostScanRecipePortSettingsArgs

ScanLevel This property is required. string
(Updatable) The scan level
ScanLevel This property is required. string
(Updatable) The scan level
scanLevel This property is required. String
(Updatable) The scan level
scanLevel This property is required. string
(Updatable) The scan level
scan_level This property is required. str
(Updatable) The scan level
scanLevel This property is required. String
(Updatable) The scan level

HostScanRecipeSchedule
, HostScanRecipeScheduleArgs

Type This property is required. string

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DayOfWeek string
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)
Type This property is required. string

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

DayOfWeek string
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)
type This property is required. String

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dayOfWeek String
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)
type This property is required. string

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dayOfWeek string
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)
type This property is required. str

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

day_of_week str
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)
type This property is required. String

(Updatable) How often the scan occurs

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

dayOfWeek String
(Updatable) Day of week the scheduled scan occurs (not applicable for DAILY type)

Import

HostScanRecipes can be imported using the id, e.g.

$ pulumi import oci:VulnerabilityScanning/hostScanRecipe:HostScanRecipe test_host_scan_recipe "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci