HostScanTarget

class oci.vulnerability_scanning.models.HostScanTarget(**kwargs)

Bases: object

A host scan target (application of a host scan recipe to a compartment or list of hosts)

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a HostScanTarget.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a HostScanTarget.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a HostScanTarget.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a HostScanTarget.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a HostScanTarget.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a HostScanTarget.

compartment_id

[Required] Gets the compartment_id of this HostScanTarget.

defined_tags

Gets the defined_tags of this HostScanTarget.

description

Gets the description of this HostScanTarget.

display_name

[Required] Gets the display_name of this HostScanTarget.

freeform_tags

Gets the freeform_tags of this HostScanTarget.

host_scan_recipe_id

[Required] Gets the host_scan_recipe_id of this HostScanTarget.

id

[Required] Gets the id of this HostScanTarget.

instance_ids

Gets the instance_ids of this HostScanTarget.

lifecycle_state

[Required] Gets the lifecycle_state of this HostScanTarget.

system_tags

Gets the system_tags of this HostScanTarget.

target_compartment_id

[Required] Gets the target_compartment_id of this HostScanTarget.

time_created

[Required] Gets the time_created of this HostScanTarget.

time_updated

[Required] Gets the time_updated of this HostScanTarget.

Methods:

__init__(**kwargs)

Initializes a new HostScanTarget object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a HostScanTarget. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new HostScanTarget 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 HostScanTarget.

  • display_name (str) – The value to assign to the display_name property of this HostScanTarget.

  • description (str) – The value to assign to the description property of this HostScanTarget.

  • compartment_id (str) – The value to assign to the compartment_id property of this HostScanTarget.

  • target_compartment_id (str) – The value to assign to the target_compartment_id property of this HostScanTarget.

  • instance_ids (list[str]) – The value to assign to the instance_ids property of this HostScanTarget.

  • host_scan_recipe_id (str) – The value to assign to the host_scan_recipe_id property of this HostScanTarget.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this HostScanTarget. 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 HostScanTarget.

  • time_updated (datetime) – The value to assign to the time_updated property of this HostScanTarget.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this HostScanTarget.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this HostScanTarget.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this HostScanTarget.

property compartment_id

[Required] Gets the compartment_id of this HostScanTarget. Compartment ID of the object (this).

Returns

The compartment_id of this HostScanTarget.

Return type

str

property defined_tags

Gets the defined_tags of this HostScanTarget. 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 HostScanTarget.

Return type

dict(str, dict(str, object))

property description

Gets the description of this HostScanTarget. Target description.

Returns

The description of this HostScanTarget.

Return type

str

property display_name

[Required] Gets the display_name of this HostScanTarget. Target identifier, which can be renamed.

Returns

The display_name of this HostScanTarget.

Return type

str

property freeform_tags

Gets the freeform_tags of this HostScanTarget. 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 HostScanTarget.

Return type

dict(str, str)

property host_scan_recipe_id

[Required] Gets the host_scan_recipe_id of this HostScanTarget. ID of the host scan recipe this target applies.

Returns

The host_scan_recipe_id of this HostScanTarget.

Return type

str

property id

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

Returns

The id of this HostScanTarget.

Return type

str

property instance_ids

Gets the instance_ids of this HostScanTarget. List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId.

Returns

The instance_ids of this HostScanTarget.

Return type

list[str]

property lifecycle_state

[Required] Gets the lifecycle_state of this HostScanTarget. 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 HostScanTarget.

Return type

str

property system_tags

Gets the system_tags of this HostScanTarget. 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 HostScanTarget.

Return type

dict(str, dict(str, object))

property target_compartment_id

[Required] Gets the target_compartment_id of this HostScanTarget. Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment.

Returns

The target_compartment_id of this HostScanTarget.

Return type

str

property time_created

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

Returns

The time_created of this HostScanTarget.

Return type

datetime

property time_updated

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

Returns

The time_updated of this HostScanTarget.

Return type

datetime