oci-cli 3.63.2__py3-none-any.whl → 3.64.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/apply-security-assessment-template.txt

@@ -0,0 +1,134 @@
+"apply-security-assessment-template"
+************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Apply the checks from the template to the specified security
+assessment.The security assessment provided in the path needs to be of
+type ‘LATEST’.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment apply-security-assessment-template [OPTIONS]
+
+
+Required Parameters
+===================
+
+--security-assessment-id [text]
+
+The OCID of the security assessment.
+
+
+Optional Parameters
+===================
+
+--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
+
+--if-match [text]
+
+For optimistic concurrency control. In the PUT or DELETE call for a
+resource, set the if-match parameter to the value of the etag from a
+previous GET or POST response for that resource. The resource will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
+--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.
+
+--template-assessment-id [text]
+
+The OCID of the template type security assessment containing the check
+details.
+
+--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
+
+       security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-safe security-assessment apply-security-assessment-template --security-assessment-id $security_assessment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/compare-to-template-baseline.txt

@@ -0,0 +1,135 @@
+"compare-to-template-baseline"
+******************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Compares two security assessments. For this comparison, the security
+assessment in the path needs to be a latest assessment of a target
+group.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment compare-to-template-baseline [OPTIONS]
+
+
+Required Parameters
+===================
+
+--comparison-security-assessment-id [text]
+
+The OCID of the security assessment. In this case a security
+assessment needs to be a template baseline assessment.
+
+--security-assessment-id [text]
+
+The OCID of the security assessment.
+
+
+Optional Parameters
+===================
+
+--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
+
+--if-match [text]
+
+For optimistic concurrency control. In the PUT or DELETE call for a
+resource, set the if-match parameter to the value of the etag from a
+previous GET or POST response for that resource. The resource will be
+updated or deleted only if the etag you provide matches the resource’s
+current etag value.
+
+--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.
+
+--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
+       export comparison_security_assessment_id=<substitute-value-of-comparison_security_assessment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/security-assessment/compare-to-template-baseline.html#cmdoption-comparison-security-assessment-id
+
+       security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-safe security-assessment compare-to-template-baseline --comparison-security-assessment-id $comparison_security_assessment_id --security-assessment-id $security_assessment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/create.txt

@@ -41,6 +41,13 @@ 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
@@ -136,8 +143,32 @@ value
 
 --target-id [text]
 
-The OCID of the target database on which security assessment is to be
-run.
+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]
 

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/download-security-assessment-report.txt

@@ -39,11 +39,11 @@ write to STDOUT.
 
 --format [text]
 
-Format of the report.
+Format of the Security Assessment report.
 
 Accepted values are:
 
-   PDF, XLS
+   PDF, STIGXLS, XLS
 
 --security-assessment-id [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/generate-security-assessment-report.txt

@@ -34,11 +34,11 @@ Required Parameters
 
 --format [text]
 
-Format of the report.
+Format of the Security Assessment report.
 
 Accepted values are:
 
-   PDF, XLS
+   PDF, STIGXLS, XLS
 
 --security-assessment-id [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/get-template-baseline-comparison.txt

@@ -0,0 +1,112 @@
+"get-template-baseline-comparison"
+**********************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets the details of the comparison report for the security assessments
+submitted for comparison.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment get-template-baseline-comparison [OPTIONS]
+
+
+Required Parameters
+===================
+
+--comparison-security-assessment-id [text]
+
+The OCID of the security assessment baseline.
+
+--security-assessment-id [text]
+
+The OCID of the security assessment.
+
+
+Optional Parameters
+===================
+
+--category [text]
+
+The category of the finding.
+
+--finding-key [text]
+
+The unique key that identifies the finding. It is a string and unique
+within a security assessment.
+
+--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
+
+--target-id [text]
+
+A filter to return only items related to a specific target OCID.
+
+
+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
+       export comparison_security_assessment_id=<substitute-value-of-comparison_security_assessment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/security-assessment/get-template-baseline-comparison.html#cmdoption-comparison-security-assessment-id
+
+       security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-safe security-assessment get-template-baseline-comparison --comparison-security-assessment-id $comparison_security_assessment_id --security-assessment-id $security_assessment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/list-checks.txt

@@ -0,0 +1,186 @@
+"list-checks"
+*************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Lists all the security checks in the specified compartment for
+security assessment of type TEMPLATE.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment list-checks [OPTIONS]
+
+
+Required Parameters
+===================
+
+--security-assessment-id [text]
+
+The OCID of the security assessment.
+
+
+Optional Parameters
+===================
+
+--access-level [text]
+
+Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED.
+Setting this to ACCESSIBLE returns only those compartments for which
+the user has INSPECT permissions directly or indirectly (permissions
+can be on a resource in a subcompartment). When set to RESTRICTED
+permissions are checked and no partial results are displayed.
+
+Accepted values are:
+
+   ACCESSIBLE, RESTRICTED
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--compartment-id-in-subtree [boolean]
+
+Default is false. When set to true, the hierarchy of compartments is
+traversed and all compartments and subcompartments in the tenancy are
+returned. Depends on the ‘accessLevel’ setting.
+
+--contains-references [text]
+
+An optional filter to return only findings that match the specified
+references. Use containsReferences param if need to filter by multiple
+references.
+
+Accepted values are:
+
+   CIS, GDPR, STIG
+
+--contains-severity [text]
+
+A filter to return only findings that match the specified risk
+level(s). Use containsSeverity parameter if need to filter by multiple
+risk levels.
+
+Accepted values are:
+
+   ADVISORY, DEFERRED, EVALUATE, HIGH, LOW, MEDIUM, PASS
+
+--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
+
+--key [text]
+
+Each check in security assessment has an associated key (think of key
+as a check’s name). For a given check, the key will be the same across
+targets. The user can use these keys to filter the checks.
+
+--limit [integer]
+
+For list pagination. The maximum number of items to return per page in
+a paginated “List” call. For details about how pagination works, see
+List Pagination.
+
+--page [text]
+
+For list pagination. The page token representing the page at which to
+start retrieving results. It is usually retrieved from a previous
+“List” call. For details about how pagination works, see List
+Pagination.
+
+--page-size [integer]
+
+When fetching results, the number of results to fetch per call. Only
+valid when used with "--all" or "--limit", and ignored otherwise.
+
+--sort-by [text]
+
+The field to sort by. You can specify only one sort order(sortOrder).
+The default order for title is ascending.
+
+Accepted values are:
+
+   category, title
+
+--sort-order [text]
+
+The sort order to use, either ascending (ASC) or descending (DESC).
+
+Accepted values are:
+
+   ASC, DESC
+
+--suggested-severity [text]
+
+A filter to return only checks of a particular risk level.
+
+Accepted values are:
+
+   ADVISORY, DEFERRED, EVALUATE, HIGH, LOW, MEDIUM, PASS
+
+
+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
+
+       security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-safe security-assessment list-checks --security-assessment-id $security_assessment_id