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/unified-audit-policy/update.txt

@@ -0,0 +1,202 @@
+"update"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the Unified Audit policy.
+
+
+Usage
+=====
+
+   oci data-safe unified-audit-policy update [OPTIONS]
+
+
+Required Parameters
+===================
+
+--unified-audit-policy-id [text]
+
+The OCID of the Unified Audit policy resource.
+
+
+Optional Parameters
+===================
+
+--conditions [complex type]
+
+Lists the audit policy provisioning conditions.
+
+This option is a JSON list with items of type PolicyCondition.  For
+documentation on PolicyCondition please see our API reference: https:
+//docs.cloud.oracle.com/api/#/en/datasafe/20181201/datatypes/PolicyCo
+ndition. 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.
+
+--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]
+
+The description of the unified audit policy in Data Safe.
+
+--display-name [text]
+
+The display name of the unified audit policy in Data Safe. The name is
+modifiable and does not need to be unique.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--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
+
+--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.
+
+--status [text]
+
+Indicates whether the policy has been enabled or disabled.
+
+--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 and paste the following example into a JSON file, replacing the
+example parameters with your own.
+
+       oci data-safe unified-audit-policy create --generate-param-json-input conditions > conditions.json
+
+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-policy/create.html#cmdoption-compartment-id
+       export status=<substitute-value-of-status> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/unified-audit-policy/create.html#cmdoption-status
+       export unified_audit_policy_definition_id=<substitute-value-of-unified_audit_policy_definition_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-safe/unified-audit-policy/create.html#cmdoption-unified-audit-policy-definition-id
+
+       security_policy_id=$(oci data-safe security-policy create --compartment-id $compartment_id --query data.id --raw-output)
+
+       unified_audit_policy_id=$(oci data-safe unified-audit-policy create --compartment-id $compartment_id --conditions file://conditions.json --security-policy-id $security_policy_id --status $status --unified-audit-policy-definition-id $unified_audit_policy_definition_id --query data.id --raw-output)
+
+       oci data-safe unified-audit-policy update --unified-audit-policy-id $unified_audit_policy_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/unified-audit-policy-collection/list-unified-audit-policies.txt

@@ -0,0 +1,385 @@
+"list-unified-audit-policies"
+*****************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Retrieves a list of all Unified Audit policies.
+
+The ListUnifiedAuditPolicies operation returns only the Unified Audit
+policies in the specified *compartmentId*.
+
+The parameter *accessLevel* specifies whether to return only those
+compartments for which the requester has INSPECT permissions on at
+least one resource directly or indirectly (ACCESSIBLE) (the resource
+can be in a sub-compartment) or to return Not Authorized if Principal
+doesn’t have access to even one of the child compartments. This is
+valid only when *compartmentIdInSubtree* is set to *true*.
+
+The parameter *compartmentIdInSubtree* applies when you perform
+ListUnifiedAuditPolicies on the *compartmentId* passed and when it is
+set to true, the entire hierarchy of compartments can be returned. To
+get a full list of all compartments and sub-compartments in the
+tenancy (root compartment), set the parameter *compartmentIdInSubtree*
+to true and *accessLevel* to ACCESSIBLE.
+
+
+Usage
+=====
+
+   oci data-safe unified-audit-policy-collection list-unified-audit-policies [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.
+
+--display-name [text]
+
+A filter to return only resources that match the specified display
+name.
+
+--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-seeded [boolean]
+
+A boolean flag indicating to list seeded unified audit policies. Set
+this parameter to get list of seeded unified audit policies.
+
+--lifecycle-state [text]
+
+The current state of the Unified Audit policy.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, NEEDS_ATTENTION, UPDATING
+
+--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.
+
+--security-policy-id [text]
+
+An optional filter to return only resources that match the specified
+OCID of the security policy resource.
+
+--sort-by [text]
+
+The field used for sorting. Only one sorting order (sortOrder) can be
+specified. The default order for TIMECREATED is descending. The
+default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order
+is case sensitive.
+
+Accepted values are:
+
+   DISPLAYNAME, TIMECREATED
+
+--sort-order [text]
+
+The sort order to use, either ascending (ASC) or descending (DESC).
+
+Accepted values are:
+
+   ASC, DESC
+
+--time-created-greater-than-or-equal-to [datetime]
+
+A filter to return only the resources that were created after the
+specified date and time, as defined by RFC3339. Using
+TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all
+resources created after that date.
+
+**Example:** 2016-12-19T16:39:57.600Z
+
+   The following datetime formats are supported:
+
+
+UTC with microseconds
+---------------------
+
+   Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
+   Example: 2017-09-15T20:30:00.123456Z
+
+   UTC with milliseconds
+   ***********************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ss.sssTZD
+       Example: 2017-09-15T20:30:00.123Z
+
+   UTC without milliseconds
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T20:30:00Z
+
+   UTC with minute precision
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T20:30Z
+
+
+Timezone with microseconds
+--------------------------
+
+   Format: YYYY-MM-DDTHH:mm:ssTZD
+   Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
+
+   Timezone with milliseconds
+   ***************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
+
+   Timezone without milliseconds
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
+
+   Timezone with minute precision
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
+
+   Short date and time
+   ********************
+   The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
+
+   .. code::
+
+       Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
+       Example: '2017-09-15 17:25'
+
+   Date Only
+   **********
+   This date will be taken as midnight UTC of that day
+
+   .. code::
+
+       Format: YYYY-MM-DD
+       Example: 2017-09-15
+
+   Epoch seconds
+   **************
+   .. code::
+
+       Example: 1412195400
+
+--time-created-less-than [datetime]
+
+Search for resources that were created before a specific date.
+Specifying this parameter corresponding *timeCreatedLessThan*
+parameter will retrieve all resources created before the specified
+created date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as
+defined by RFC 3339.
+
+**Example:** 2016-12-19T16:39:57.600Z
+
+   The following datetime formats are supported:
+
+
+UTC with microseconds
+---------------------
+
+   Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
+   Example: 2017-09-15T20:30:00.123456Z
+
+   UTC with milliseconds
+   ***********************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ss.sssTZD
+       Example: 2017-09-15T20:30:00.123Z
+
+   UTC without milliseconds
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T20:30:00Z
+
+   UTC with minute precision
+   **************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T20:30Z
+
+
+Timezone with microseconds
+--------------------------
+
+   Format: YYYY-MM-DDTHH:mm:ssTZD
+   Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800
+
+   Timezone with milliseconds
+   ***************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
+
+   Timezone without milliseconds
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mm:ssTZD
+       Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
+
+   Timezone with minute precision
+   *******************************
+   .. code::
+
+       Format: YYYY-MM-DDTHH:mmTZD
+       Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800
+
+   Short date and time
+   ********************
+   The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
+
+   .. code::
+
+       Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
+       Example: '2017-09-15 17:25'
+
+   Date Only
+   **********
+   This date will be taken as midnight UTC of that day
+
+   .. code::
+
+       Format: YYYY-MM-DD
+       Example: 2017-09-15
+
+   Epoch seconds
+   **************
+   .. code::
+
+       Example: 1412195400
+
+--unified-audit-policy-definition-id [text]
+
+An optional filter to return only resources that match the specified
+OCID of the unified audit policy definition resource.
+
+--unified-audit-policy-id [text]
+
+An optional filter to return only resources that match the specified
+OCID of the Unified Audit policy resource.
+
+
+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/unified-audit-policy-collection/list-unified-audit-policies.html#cmdoption-compartment-id
+
+       oci data-safe unified-audit-policy-collection list-unified-audit-policies --compartment-id $compartment_id

oci_cli/help_text_producer/data_files/text/cmdref/data-safe/unified-audit-policy-collection.txt

@@ -0,0 +1,14 @@
+unified-audit-policy-collection
+*******************************
+
+
+Description
+===========
+
+Collection of audit policy summaries.
+
+
+Available Commands
+==================
+
+* list-unified-audit-policies