oci-cli 3.63.3__py3-none-any.whl → 3.64.1__py3-none-any.whl

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

@@ -0,0 +1,188 @@
+"list-template-analytics"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of template aggregated details in the specified
+compartment. This provides information about the overall template
+usage, by returning the count of the target databases/target groups
+using the templates. It also provides information about the statistics
+for the template baseline and the comparison related. If the
+comparison is done, it will show if there is any drift, and how many
+checks have drifts. The dimension field - isGroup identifies if the
+targetId belongs to a target group or a individual target. The
+dimension field - isCompared identifies if the comparison between the
+latest assessment and the template baseline assessment is done or not.
+The dimension field - isCompliant identifies if the latest assessment
+is compliant with the template baseline assessment or not. The
+dimension field - totalChecksFailed identifies how many checks in the
+template have drifts in the comparison.
+
+When you perform the ListTemplateAnalytics operation, if the parameter
+compartmentIdInSubtree is set to “true,” and if the parameter
+accessLevel is set to ACCESSIBLE, then the operation returns
+statistics from the compartments in which the requestor has INSPECT
+permissions on at least one resource, directly or indirectly (in
+subcompartments). If the operation is performed at the root
+compartment and the requestor does not have access to at least one
+subcompartment of the compartment specified by compartmentId, then
+“Not Authorized” is returned.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment list-template-analytics [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+A filter to return only resources that match the specified compartment
+OCID.
+
+
+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.
+
+--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-compared [boolean]
+
+A filter to return only the statistics where the comparison between
+the latest assessment and the template baseline assessment is done.
+
+--is-compliant [boolean]
+
+A filter to return only the statistics where the latest assessment is
+compliant with the template baseline assessment.
+
+--is-group [boolean]
+
+A filter to return only the target group related information if the
+OCID belongs to a target group.
+
+--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.
+
+--target-database-group-id [text]
+
+A filter to return the target database group that matches the
+specified OCID.
+
+--target-id [text]
+
+A filter to return only items related to a specific target OCID.
+
+--template-assessment-id [text]
+
+The OCID of the security assessment of type TEMPLATE.
+
+--template-baseline-assessment-id [text]
+
+The OCID of the security assessment of type TEMPLATE_BASELINE.
+
+
+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/list-template-analytics.html#cmdoption-compartment-id
+
+       oci data-safe security-assessment list-template-analytics --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/security-assessment/list-template-association-analytics.txt

@@ -0,0 +1,174 @@
+"list-template-association-analytics"
+*************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Gets a list of template association details in the specified
+compartment. This provides information about the overall template
+usage, by returning the count of the target databases/target groups
+using the templates.
+
+If the template baseline is created for a target group which contains
+several targets, we will have each individual target listed there as
+targetId field together with targetDatabaseGroupId. And if the
+template baseline is created for an individual target, it will have
+targetId field only.
+
+By leveraging the targetId filter, you will be able to know all the
+template or template baseline that this target has something to do
+with. No matter if they are directly applied or created for this
+target, or they are for the target group the target belongs to.
+
+When you perform the ListTemplateAssociationAnalytics operation, if
+the parameter compartmentIdInSubtree is set to “true,” and if the
+parameter accessLevel is set to ACCESSIBLE, then the operation returns
+statistics from the compartments in which the requestor has INSPECT
+permissions on at least one resource, directly or indirectly (in
+subcompartments). If the operation is performed at the root
+compartment and the requestor does not have access to at least one
+subcompartment of the compartment specified by compartmentId, then
+“Not Authorized” is returned.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment list-template-association-analytics [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+A filter to return only resources that match the specified compartment
+OCID.
+
+
+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.
+
+--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
+
+--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.
+
+--target-database-group-id [text]
+
+A filter to return the target database group that matches the
+specified OCID.
+
+--target-id [text]
+
+A filter to return only items related to a specific target OCID.
+
+--template-assessment-id [text]
+
+The OCID of the security assessment of type TEMPLATE.
+
+--template-baseline-assessment-id [text]
+
+The OCID of the security assessment of type TEMPLATE_BASELINE.
+
+
+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/list-template-association-analytics.html#cmdoption-compartment-id
+
+       oci data-safe security-assessment list-template-association-analytics --compartment-id $compartment_id

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

@@ -153,7 +153,7 @@ The default order for timeCreated is descending.
 
 Accepted values are:
 
-   displayName, timeCreated
+   displayName, timeCreated, timeLastAssessed, timeUpdated
 
 --sort-order [text]
 
@@ -163,10 +163,28 @@ Accepted values are:
 
    ASC, DESC
 
+--target-database-group-id [text]
+
+A filter to return the target database group that matches the
+specified OCID.
+
 --target-id [text]
 
 A filter to return only items related to a specific target OCID.
 
+--target-type [text]
+
+A filter to return only only target database resources or target
+database group resources.
+
+Accepted values are:
+
+   TARGET_DATABASE, TARGET_DATABASE_GROUP
+
+--template-assessment-id [text]
+
+The OCID of the security assessment of type TEMPLATE.
+
 --time-created-greater-than-or-equal-to [datetime]
 
 A filter to return only the resources that were created after the
@@ -352,7 +370,7 @@ Timezone with microseconds
 
 --triggered-by [text]
 
-A filter to return only security asessments that were created by
+A filter to return only security assessments that were created by
 either user or system.
 
 Accepted values are:
@@ -366,7 +384,7 @@ assessment type.
 
 Accepted values are:
 
-   COMPARTMENT, LATEST, SAVED, SAVE_SCHEDULE
+   COMPARTMENT, LATEST, SAVED, SAVE_SCHEDULE, TEMPLATE, TEMPLATE_BASELINE
 
 
 Global Parameters

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

@@ -0,0 +1,145 @@
+"patch-checks"
+**************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Patches one or more checks in the specified template type security
+assessment. Use it to add or delete checks. To add check, use
+CreateCheckDetails as the patch value.
+
+
+Usage
+=====
+
+   oci data-safe security-assessment patch-checks [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.
+
+--items [complex type]
+
+An array of patch instructions.
+
+This option is a JSON list with items of type PatchInstruction.  For
+documentation on PatchInstruction please see our API reference: https
+://docs.cloud.oracle.com/api/#/en/datasafe/20181201/datatypes/PatchIn
+struction. 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.
+
+--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
+
+       security_assessment_id=$(oci data-safe security-assessment create --compartment-id $compartment_id --query data.id --raw-output)
+
+       oci data-safe security-assessment patch-checks --security-assessment-id $security_assessment_id