oracle.oci.oci_data_safe_user_assessment_actions – Perform actions on an UserAssessment resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_data_safe_user_assessment_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on an UserAssessment resource in Oracle Cloud Infrastructure
For action=change_compartment, moves the specified saved user assessment or future scheduled assessments into a different compartment. To start storing scheduled user assessments on a different compartment, first call the operation ListUserAssessments with the filters “type = save_schedule”. That call returns the scheduleAssessmentId. Then call ChangeUserAssessmentCompartment with the scheduleAssessmentId. The existing saved user assessments created per the schedule are not be moved. However, all new saves will be associated with the new compartment.
For action=set_user_assessment_baseline, sets the saved user assessment as the baseline in the compartment where the specified assessment resides. The user assessment needs to be of type ‘SAVED’.
For action=unset_user_assessment_baseline, removes the baseline setting for the saved user assessment. The saved user assessment is no longer considered a baseline. Sets the if-match parameter to the value of the etag from a previous GET or POST response for that resource.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
action
string
/ required
|
|
The action to perform on the UserAssessment.
|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|
assessment_ids
list
/ elements=string
|
The list of OCIDs for the user assessments that need to be updated while setting the baseline.
Applicable only for action=set_user_assessment_baseline.
|
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
compartment_id
string
|
The OCID of the compartment where you want to move the user assessment.
Required for action=change_compartment.
|
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|
user_assessment_id
string
/ required
|
The OCID of the user assessment.
aliases: id |
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action change_compartment on user_assessment
oci_data_safe_user_assessment_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action set_user_assessment_baseline on user_assessment
oci_data_safe_user_assessment_actions:
# required
user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"
action: set_user_assessment_baseline
# optional
assessment_ids: [ "assessment_ids_example" ]
- name: Perform action unset_user_assessment_baseline on user_assessment
oci_data_safe_user_assessment_actions:
# required
user_assessment_id: "ocid1.userassessment.oc1..xxxxxxEXAMPLExxxxxx"
action: unset_user_assessment_baseline
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
user_assessment
complex
|
on success |
Details of the UserAssessment resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ignored_assessment_ids': [], 'ignored_targets': [], 'is_baseline': True, 'is_deviated_from_baseline': True, 'last_compared_baseline_id': 'ocid1.lastcomparedbaseline.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'schedule': 'schedule_example', 'schedule_assessment_id': 'ocid1.scheduleassessment.oc1..xxxxxxEXAMPLExxxxxx', 'statistics': {}, 'system_tags': {}, 'target_ids': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_assessed': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'triggered_by': 'USER', 'type': 'LATEST'}
|
|
compartment_id
string
|
on success |
The OCID of the compartment that contains the user assessment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
description
string
|
on success |
The description of the user assessment.
Sample:
description_example
|
|
display_name
string
|
on success |
The display name of the user assessment.
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
The OCID of the user assessment.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
ignored_assessment_ids
list
/ elements=string
|
on success |
List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }`
|
|
ignored_targets
list
/ elements=string
|
on success |
List containing maps as values. Example: `{"Operations": [ {"CostCenter": "42"} ] }`
|
|
is_baseline
boolean
|
on success |
Indicates if the user assessment is set as a baseline. This is applicable only to saved user assessments.
Sample:
True
|
|
is_deviated_from_baseline
boolean
|
on success |
Indicates if the user assessment deviates from the baseline.
Sample:
True
|
|
last_compared_baseline_id
string
|
on success |
The OCID of the last user assessment baseline against which the latest assessment was compared.
Sample:
ocid1.lastcomparedbaseline.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_details
string
|
on success |
Details about the current state of the user assessment.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of the user assessment.
Sample:
CREATING
|
|
schedule
string
|
on success |
Schedule of the assessment that runs periodically in this specified format: <version-string>;<version-specific-schedule>
Allowed version strings - "v1" v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is '*'. When not, day of week must equal the given value <day-of-month> can be either '*' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is '*'. When not, day of month must equal the given value
Sample:
schedule_example
|
|
schedule_assessment_id
string
|
on success |
The OCID of the user assessment that is responsible for creating this scheduled save assessment.
Sample:
ocid1.scheduleassessment.oc1..xxxxxxEXAMPLExxxxxx
|
|
statistics
dictionary
|
on success |
Map that contains maps of values. Example: `{"Operations": {"CostCenter": "42"}}`
|
|
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|
target_ids
list
/ elements=string
|
on success |
Array of database target OCIDs.
|
|
time_created
string
|
on success |
The date and time the user assessment was created, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_last_assessed
string
|
on success |
The date and time the user assessment was last executed, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The date and time the user assessment was last updated, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
triggered_by
string
|
on success |
Indicates whether the user assessment was created by the system or the user.
Sample:
USER
|
|
type
string
|
on success |
The type of the user assessment. The possible types are:
LATEST: The latest assessment that was executed for a target. It can either be system generated as part of the scheduled assessments or user driven by refreshing the latest assessment. SAVED: A saved user assessment. All user assessments are saved in the user assessment history. SAVE_SCHEDULE: The schedule to periodically save the LATEST assessment of a target database. COMPARTMENT: An automatic managed assessment type that stores all details of the targets in one compartment. This will keep an up-to-date status of all potential risks identified in the compartment. It also keeps track of user count and target count for each profile available on the targets in a given compartment. It is automatically updated once the latest assessment or refresh action is executed, as well as when a target is deleted or moved to a different compartment.
Sample:
LATEST
|
Authors¶
Oracle (@oracle)