Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.VulnerabilityScanning.getHostScanRecipe
Explore with Pulumi AI
This data source provides details about a specific Host Scan Recipe resource in Oracle Cloud Infrastructure Vulnerability Scanning service.
Retrieves a HostScanRecipe identified by the recipe ID. 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 = oci.VulnerabilityScanning.getHostScanRecipe({
hostScanRecipeId: testHostScanRecipeOciVulnerabilityScanningHostScanRecipe.id,
});
import pulumi
import pulumi_oci as oci
test_host_scan_recipe = oci.VulnerabilityScanning.get_host_scan_recipe(host_scan_recipe_id=test_host_scan_recipe_oci_vulnerability_scanning_host_scan_recipe["id"])
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.GetHostScanRecipe(ctx, &vulnerabilityscanning.GetHostScanRecipeArgs{
HostScanRecipeId: testHostScanRecipeOciVulnerabilityScanningHostScanRecipe.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testHostScanRecipe = Oci.VulnerabilityScanning.GetHostScanRecipe.Invoke(new()
{
HostScanRecipeId = testHostScanRecipeOciVulnerabilityScanningHostScanRecipe.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.VulnerabilityScanning.VulnerabilityScanningFunctions;
import com.pulumi.oci.VulnerabilityScanning.inputs.GetHostScanRecipeArgs;
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) {
final var testHostScanRecipe = VulnerabilityScanningFunctions.getHostScanRecipe(GetHostScanRecipeArgs.builder()
.hostScanRecipeId(testHostScanRecipeOciVulnerabilityScanningHostScanRecipe.id())
.build());
}
}
variables:
testHostScanRecipe:
fn::invoke:
Function: oci:VulnerabilityScanning:getHostScanRecipe
Arguments:
hostScanRecipeId: ${testHostScanRecipeOciVulnerabilityScanningHostScanRecipe.id}
Using getHostScanRecipe
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getHostScanRecipe(args: GetHostScanRecipeArgs, opts?: InvokeOptions): Promise<GetHostScanRecipeResult>
function getHostScanRecipeOutput(args: GetHostScanRecipeOutputArgs, opts?: InvokeOptions): Output<GetHostScanRecipeResult>
def get_host_scan_recipe(host_scan_recipe_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetHostScanRecipeResult
def get_host_scan_recipe_output(host_scan_recipe_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetHostScanRecipeResult]
func GetHostScanRecipe(ctx *Context, args *GetHostScanRecipeArgs, opts ...InvokeOption) (*GetHostScanRecipeResult, error)
func GetHostScanRecipeOutput(ctx *Context, args *GetHostScanRecipeOutputArgs, opts ...InvokeOption) GetHostScanRecipeResultOutput
> Note: This function is named GetHostScanRecipe
in the Go SDK.
public static class GetHostScanRecipe
{
public static Task<GetHostScanRecipeResult> InvokeAsync(GetHostScanRecipeArgs args, InvokeOptions? opts = null)
public static Output<GetHostScanRecipeResult> Invoke(GetHostScanRecipeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetHostScanRecipeResult> getHostScanRecipe(GetHostScanRecipeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:VulnerabilityScanning/getHostScanRecipe:getHostScanRecipe
arguments:
# arguments dictionary
The following arguments are supported:
- Host
Scan stringRecipe Id - unique HostScanRecipe identifier
- Host
Scan stringRecipe Id - unique HostScanRecipe identifier
- host
Scan StringRecipe Id - unique HostScanRecipe identifier
- host
Scan stringRecipe Id - unique HostScanRecipe identifier
- host_
scan_ strrecipe_ id - unique HostScanRecipe identifier
- host
Scan StringRecipe Id - unique HostScanRecipe identifier
getHostScanRecipe Result
The following output properties are available:
- Agent
Settings List<GetHost Scan Recipe Agent Setting> - Agent scan settings for a host scan
- Application
Settings List<GetHost Scan Recipe Application Setting> - Agent scan settings for an application scan (as a part of a host scan)
- Compartment
Id string - Compartment ID of the scan recipe
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - Recipe identifier, which can be renamed
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Host
Scan stringRecipe Id - Id string
- Unique identifier of the config that is immutable on creation
- Port
Settings List<GetHost Scan Recipe Port Setting> - Port scan settings for a host scan
- Schedules
List<Get
Host Scan Recipe Schedule> - A scanning schedule
- State string
- The current state of the config.
- Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Date and time the recipe was created, format as described in RFC 3339
- Time
Updated string - Date and time the recipe was last updated, format as described in RFC 3339
- Agent
Settings []GetHost Scan Recipe Agent Setting - Agent scan settings for a host scan
- Application
Settings []GetHost Scan Recipe Application Setting - Agent scan settings for an application scan (as a part of a host scan)
- Compartment
Id string - Compartment ID of the scan recipe
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - Recipe identifier, which can be renamed
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Host
Scan stringRecipe Id - Id string
- Unique identifier of the config that is immutable on creation
- Port
Settings []GetHost Scan Recipe Port Setting - Port scan settings for a host scan
- Schedules
[]Get
Host Scan Recipe Schedule - A scanning schedule
- State string
- The current state of the config.
- map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Date and time the recipe was created, format as described in RFC 3339
- Time
Updated string - Date and time the recipe was last updated, format as described in RFC 3339
- agent
Settings List<GetHost Scan Recipe Agent Setting> - Agent scan settings for a host scan
- application
Settings List<GetHost Scan Recipe Application Setting> - Agent scan settings for an application scan (as a part of a host scan)
- compartment
Id String - Compartment ID of the scan recipe
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - Recipe identifier, which can be renamed
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host
Scan StringRecipe Id - id String
- Unique identifier of the config that is immutable on creation
- port
Settings List<GetHost Scan Recipe Port Setting> - Port scan settings for a host scan
- schedules
List<Get
Host Scan Recipe Schedule> - A scanning schedule
- state String
- The current state of the config.
- Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Date and time the recipe was created, format as described in RFC 3339
- time
Updated String - Date and time the recipe was last updated, format as described in RFC 3339
- agent
Settings GetHost Scan Recipe Agent Setting[] - Agent scan settings for a host scan
- application
Settings GetHost Scan Recipe Application Setting[] - Agent scan settings for an application scan (as a part of a host scan)
- compartment
Id string - Compartment ID of the scan recipe
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - Recipe identifier, which can be renamed
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host
Scan stringRecipe Id - id string
- Unique identifier of the config that is immutable on creation
- port
Settings GetHost Scan Recipe Port Setting[] - Port scan settings for a host scan
- schedules
Get
Host Scan Recipe Schedule[] - A scanning schedule
- state string
- The current state of the config.
- {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - Date and time the recipe was created, format as described in RFC 3339
- time
Updated string - Date and time the recipe was last updated, format as described in RFC 3339
- agent_
settings Sequence[vulnerabilityscanning.Get Host Scan Recipe Agent Setting] - Agent scan settings for a host scan
- application_
settings Sequence[vulnerabilityscanning.Get Host Scan Recipe Application Setting] - Agent scan settings for an application scan (as a part of a host scan)
- compartment_
id str - Compartment ID of the scan recipe
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display_
name str - Recipe identifier, which can be renamed
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host_
scan_ strrecipe_ id - id str
- Unique identifier of the config that is immutable on creation
- port_
settings Sequence[vulnerabilityscanning.Get Host Scan Recipe Port Setting] - Port scan settings for a host scan
- schedules
Sequence[vulnerabilityscanning.
Get Host Scan Recipe Schedule] - A scanning schedule
- state str
- The current state of the config.
- 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
- agent
Settings List<Property Map> - Agent scan settings for a host scan
- application
Settings List<Property Map> - Agent scan settings for an application scan (as a part of a host scan)
- compartment
Id String - Compartment ID of the scan recipe
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - Recipe identifier, which can be renamed
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- host
Scan StringRecipe Id - id String
- Unique identifier of the config that is immutable on creation
- port
Settings List<Property Map> - Port scan settings for a host scan
- schedules List<Property Map>
- A scanning schedule
- state String
- The current state of the config.
- Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Date and time the recipe was created, format as described in RFC 3339
- time
Updated String - Date and time the recipe was last updated, format as described in RFC 3339
Supporting Types
GetHostScanRecipeAgentSetting
- Agent
Configurations List<GetHost Scan Recipe Agent Setting Agent Configuration> - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- Scan
Level string - The scan level
- Agent
Configurations []GetHost Scan Recipe Agent Setting Agent Configuration - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- Scan
Level string - The scan level
- agent
Configurations List<GetHost Scan Recipe Agent Setting Agent Configuration> - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- scan
Level String - The scan level
- agent
Configurations GetHost Scan Recipe Agent Setting Agent Configuration[] - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- scan
Level string - The scan level
- agent_
configurations Sequence[vulnerabilityscanning.Get Host Scan Recipe Agent Setting Agent Configuration] - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- scan_
level str - The scan level
- agent
Configurations List<Property Map> - Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor.
- scan
Level String - The scan level
GetHostScanRecipeAgentSettingAgentConfiguration
- Cis
Benchmark List<GetSettings Host Scan Recipe Agent Setting Agent Configuration Cis Benchmark Setting> - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- Endpoint
Protection List<GetSettings Host Scan Recipe Agent Setting Agent Configuration Endpoint Protection Setting> - Endpoint Protection scan settings for a host scan
- Should
Un boolInstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- Vault
Secret stringId - 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 string
- Vendor to use for the host scan agent.
- Vendor
Type string - Vendor to use for the host scan agent.
- Cis
Benchmark []GetSettings Host Scan Recipe Agent Setting Agent Configuration Cis Benchmark Setting - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- Endpoint
Protection []GetSettings Host Scan Recipe Agent Setting Agent Configuration Endpoint Protection Setting - Endpoint Protection scan settings for a host scan
- Should
Un boolInstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- Vault
Secret stringId - 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 string
- Vendor to use for the host scan agent.
- Vendor
Type string - Vendor to use for the host scan agent.
- cis
Benchmark List<GetSettings Host Scan Recipe Agent Setting Agent Configuration Cis Benchmark Setting> - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- endpoint
Protection List<GetSettings Host Scan Recipe Agent Setting Agent Configuration Endpoint Protection Setting> - Endpoint Protection scan settings for a host scan
- should
Un BooleanInstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- vault
Secret StringId - 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 String
- Vendor to use for the host scan agent.
- vendor
Type String - Vendor to use for the host scan agent.
- cis
Benchmark GetSettings Host Scan Recipe Agent Setting Agent Configuration Cis Benchmark Setting[] - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- endpoint
Protection GetSettings Host Scan Recipe Agent Setting Agent Configuration Endpoint Protection Setting[] - Endpoint Protection scan settings for a host scan
- should
Un booleanInstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- vault
Secret stringId - 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 string
- Vendor to use for the host scan agent.
- vendor
Type string - Vendor to use for the host scan agent.
- cis_
benchmark_ Sequence[vulnerabilityscanning.settings Get Host Scan Recipe Agent Setting Agent Configuration Cis Benchmark Setting] - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- endpoint_
protection_ Sequence[vulnerabilityscanning.settings Get Host Scan Recipe Agent Setting Agent Configuration Endpoint Protection Setting] - Endpoint Protection scan settings for a host scan
- should_
un_ boolinstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- vault_
secret_ strid - 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 str
- Vendor to use for the host scan agent.
- vendor_
type str - Vendor to use for the host scan agent.
- cis
Benchmark List<Property Map>Settings - CIS (Center for Internet Security) Benchmark scan settings for a host scan
- endpoint
Protection List<Property Map>Settings - Endpoint Protection scan settings for a host scan
- should
Un BooleanInstall - Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.
- vault
Secret StringId - 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 String
- Vendor to use for the host scan agent.
- vendor
Type String - Vendor to use for the host scan agent.
GetHostScanRecipeAgentSettingAgentConfigurationCisBenchmarkSetting
- Scan
Level string - The scan level
- Scan
Level string - The scan level
- scan
Level String - The scan level
- scan
Level string - The scan level
- scan_
level str - The scan level
- scan
Level String - The scan level
GetHostScanRecipeAgentSettingAgentConfigurationEndpointProtectionSetting
- Scan
Level string - The scan level
- Scan
Level string - The scan level
- scan
Level String - The scan level
- scan
Level string - The scan level
- scan_
level str - The scan level
- scan
Level String - The scan level
GetHostScanRecipeApplicationSetting
- Application
Scan stringRecurrence - 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 List<GetScans Host Scan Recipe Application Setting Folders To Scan> - List of folders selected for scanning
- Is
Enabled bool - Enable or disable application scan
- Application
Scan stringRecurrence - 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 []GetScans Host Scan Recipe Application Setting Folders To Scan - List of folders selected for scanning
- Is
Enabled bool - Enable or disable application scan
- application
Scan StringRecurrence - 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 List<GetScans Host Scan Recipe Application Setting Folders To Scan> - List of folders selected for scanning
- is
Enabled Boolean - Enable or disable application scan
- application
Scan stringRecurrence - 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 GetScans Host Scan Recipe Application Setting Folders To Scan[] - List of folders selected for scanning
- is
Enabled boolean - Enable or disable application scan
- application_
scan_ strrecurrence - 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_ Sequence[vulnerabilityscanning.scans Get Host Scan Recipe Application Setting Folders To Scan] - List of folders selected for scanning
- is_
enabled bool - Enable or disable application scan
- application
Scan StringRecurrence - 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 List<Property Map>Scans - List of folders selected for scanning
- is
Enabled Boolean - Enable or disable application scan
GetHostScanRecipeApplicationSettingFoldersToScan
- Folder string
- Folder to be scanned in the corresponding operating system
- Operatingsystem string
- Operating system type
- Folder string
- Folder to be scanned in the corresponding operating system
- Operatingsystem string
- Operating system type
- folder String
- Folder to be scanned in the corresponding operating system
- operatingsystem String
- Operating system type
- folder string
- Folder to be scanned in the corresponding operating system
- operatingsystem string
- Operating system type
- folder str
- Folder to be scanned in the corresponding operating system
- operatingsystem str
- Operating system type
- folder String
- Folder to be scanned in the corresponding operating system
- operatingsystem String
- Operating system type
GetHostScanRecipePortSetting
- Scan
Level string - The scan level
- Scan
Level string - The scan level
- scan
Level String - The scan level
- scan
Level string - The scan level
- scan_
level str - The scan level
- scan
Level String - The scan level
GetHostScanRecipeSchedule
- day_
of_ strweek - Day of week the scheduled scan occurs (not applicable for DAILY type)
- type str
- How often the scan occurs
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.