HostScanRecipe¶

class oci.vulnerability_scanning.models.HostScanRecipe(**kwargs)¶

Bases: object

A host scan recipe (collection of host scanning configuration settings)

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a HostScanRecipe.
`agent_settings`	[Required] Gets the agent_settings of this HostScanRecipe.
`application_settings`	Gets the application_settings of this HostScanRecipe.
`compartment_id`	[Required] Gets the compartment_id of this HostScanRecipe.
`defined_tags`	Gets the defined_tags of this HostScanRecipe.
`display_name`	[Required] Gets the display_name of this HostScanRecipe.
`freeform_tags`	Gets the freeform_tags of this HostScanRecipe.
`id`	[Required] Gets the id of this HostScanRecipe.
`lifecycle_state`	[Required] Gets the lifecycle_state of this HostScanRecipe.
`port_settings`	[Required] Gets the port_settings of this HostScanRecipe.
`schedule`	[Required] Gets the schedule of this HostScanRecipe.
`system_tags`	Gets the system_tags of this HostScanRecipe.
`time_created`	[Required] Gets the time_created of this HostScanRecipe.
`time_updated`	[Required] Gets the time_updated of this HostScanRecipe.

Methods

__init__(**kwargs) Initializes a new HostScanRecipe object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a HostScanRecipe. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new HostScanRecipe object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this HostScanRecipe.
display_name (str) – The value to assign to the display_name property of this HostScanRecipe.
compartment_id (str) – The value to assign to the compartment_id property of this HostScanRecipe.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostScanRecipe. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this HostScanRecipe.
time_updated (datetime) – The value to assign to the time_updated property of this HostScanRecipe.
port_settings (oci.vulnerability_scanning.models.HostScanPortSettings) – The value to assign to the port_settings property of this HostScanRecipe.
agent_settings (oci.vulnerability_scanning.models.HostScanAgentSettings) – The value to assign to the agent_settings property of this HostScanRecipe.
application_settings (oci.vulnerability_scanning.models.ApplicationScanSettings) – The value to assign to the application_settings property of this HostScanRecipe.
schedule (oci.vulnerability_scanning.models.Schedule) – The value to assign to the schedule property of this HostScanRecipe.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostScanRecipe.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostScanRecipe.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostScanRecipe.

agent_settings¶

[Required] Gets the agent_settings of this HostScanRecipe.

Returns:	The agent_settings of this HostScanRecipe.
Return type:	oci.vulnerability_scanning.models.HostScanAgentSettings

application_settings¶

Gets the application_settings of this HostScanRecipe.

Returns:	The application_settings of this HostScanRecipe.
Return type:	oci.vulnerability_scanning.models.ApplicationScanSettings

compartment_id¶

[Required] Gets the compartment_id of this HostScanRecipe. Compartment ID of the scan recipe

Returns:	The compartment_id of this HostScanRecipe.
Return type:	str

defined_tags¶

Gets the defined_tags of this HostScanRecipe. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this HostScanRecipe.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this HostScanRecipe. Recipe identifier, which can be renamed

Returns:	The display_name of this HostScanRecipe.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this HostScanRecipe. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this HostScanRecipe.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this HostScanRecipe. Unique identifier of the config that is immutable on creation

Returns:	The id of this HostScanRecipe.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this HostScanRecipe. The current state of the config.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this HostScanRecipe.
Return type:	str

port_settings¶

[Required] Gets the port_settings of this HostScanRecipe.

Returns:	The port_settings of this HostScanRecipe.
Return type:	oci.vulnerability_scanning.models.HostScanPortSettings

schedule¶

[Required] Gets the schedule of this HostScanRecipe.

Returns:	The schedule of this HostScanRecipe.
Return type:	oci.vulnerability_scanning.models.Schedule

system_tags¶

Gets the system_tags of this HostScanRecipe. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this HostScanRecipe.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this HostScanRecipe. Date and time the recipe was created, format as described in RFC 3339

Returns:	The time_created of this HostScanRecipe.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this HostScanRecipe. Date and time the recipe was last updated, format as described in RFC 3339

Returns:	The time_updated of this HostScanRecipe.
Return type:	datetime