"create"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Creates a new saved security assessment for one or multiple targets in
a compartment. When this operation is performed, it will save the
latest assessments in the specified compartment. If a schedule is
passed, it will persist the latest assessments, at the defined date
and time, in the format defined by RFC3339.


Usage
=====

   oci data-safe security-assessment create [OPTIONS]


Required Parameters
===================

--compartment-id, -c [text]

The OCID of the compartment that contains the security assessment.


Optional Parameters
===================

--base-security-assessment-id [text]

The OCID of the security assessment. The assessment should be of type
SAVED. It will be required while creating the template baseline
assessment for individual targets to fetch the detailed information
from an existing security assessment.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see Resource Tags Example:
*{“Operations”: {“CostCenter”: “42”}}* This is a complex type whose
value must be valid JSON. The value can be provided as a string on the
command line or passed in as a file using the file://path/to/file
syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--description [text]

Description of the security assessment.

--display-name [text]

The display name of the security assessment.

--freeform-tags [complex type]

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"}

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--is-assessment-scheduled [boolean]

Indicates whether the assessment is scheduled to run.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state
defined by "--wait-for-state". Defaults to 1200 seconds.

--schedule [text]

To schedule the assessment for running periodically, specify the
schedule in this attribute. Create or schedule one assessment per
compartment. If not defined, the assessment runs immediately. 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

--target-id [text]

The OCID of the target database or target database group on which
security assessment is to be run.

--target-type [text]

The type of security assessment resource whether it is individual or
group resource. For individual target use type TARGET_DATABASE and for
group resource use type TARGET_DATABASE_GROUP. If not provided,
TARGET_DATABASE would be used as default value.

Accepted values are:

   TARGET_DATABASE, TARGET_DATABASE_GROUP

--template-assessment-id [text]

The OCID of the template assessment. It will be required while
creating the template baseline assessment.

--type [text]

The type of the security assessment

Accepted values are:

   COMPARTMENT, LATEST, SAVED, SAVE_SCHEDULE, TEMPLATE, TEMPLATE_BASELINE

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource
and uses a work request to track the progress of the operation.
Specify this option to perform the action and then wait until the work
request reaches a certain state. Multiple states can be specified,
returning on the first state. For example, "--wait-for-state"
SUCCEEDED "--wait-for-state" FAILED would return on whichever
lifecycle state is reached first. If timeout is reached, a return code
of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, SUSPENDED, SUSPENDING

--wait-interval-seconds [integer]

Check every "--wait-interval-seconds" to see whether the work request
has reached the state defined by "--wait-for-state". Defaults to 30
seconds.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--endpoint", "--generate-full-command-json-input", "
--generate-param-json-input", "--help", "--latest-version", "--max-
retries", "--no-retry", "--opc-client-request-id", "--opc-request-id",
"--output", "--profile", "--proxy", "--query", "--raw-output", "--
read-timeout", "--realm-specific-endpoint", "--region", "--release-
info", "--request-id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/security-assessment/create.html#cmdoption-compartment-id

       oci data-safe security-assessment create --compartment-id $compartment_id
