oci-cli 3.72.1__py3-none-any.whl → 3.73.1__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/certs-mgmt/certificate-authority/create-subordinate-ca-managed-internally-issued-by-external-ca.txt

@@ -0,0 +1,229 @@
+"create-subordinate-ca-managed-internally-issued-by-external-ca"
+****************************************************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Creates a new certificate authority (CA) according to the details of
+the request.
+
+
+Usage
+=====
+
+   oci certs-mgmt certificate-authority create-subordinate-ca-managed-internally-issued-by-external-ca [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The compartment in which you want to create the CA.
+
+--issuer-certificate-authority-id [text]
+
+The OCID of the private, external issuer CA.
+
+--name [text]
+
+A user-friendly name for the CA. Names are unique within a
+compartment. Avoid entering confidential information. Valid characters
+include uppercase or lowercase letters, numbers, hyphens, underscores,
+and periods.
+
+--subject [complex type]
+
+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.
+
+
+Optional Parameters
+===================
+
+--certificate-authority-rules [complex type]
+
+A list of rules that control how the CA is used and managed.
+
+This option is a JSON list with items of type
+CertificateAuthorityRule.  For documentation on
+CertificateAuthorityRule please see our API reference: https://docs.c
+loud.oracle.com/api/#/en/certificatesmanagement/20210224/datatypes/Ce
+rtificateAuthorityRule. 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.
+
+--certificate-revocation-list-details [complex type]
+
+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]
+
+Usage of predefined tag keys. These predefined keys are scoped to
+namespaces. Example: *{“foo-namespace”: {“bar-key”: “value”}}* 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]
+
+A brief description of the CA.
+
+--external-key-description [text]
+
+For externally managed CAs, a description of the externally managed
+private key. Avoid entering confidential information.
+
+--freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only. Example: *{“bar-
+key”: “value”}* 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
+
+--kms-key-id [text]
+
+The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt
+the CA.
+
+--max-wait-seconds [integer]
+
+The maximum time to wait for the resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--signing-algorithm [text]
+
+The algorithm used to sign public key certificates that the CA issues.
+
+Accepted values are:
+
+   SHA256_WITH_ECDSA, SHA256_WITH_RSA, SHA384_WITH_ECDSA, SHA384_WITH_RSA, SHA512_WITH_ECDSA, SHA512_WITH_RSA
+
+--version-name [text]
+
+The name of the CA version. When the value is not null, a name is
+unique across versions of a given CA.
+
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle 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:
+
+   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_ACTIVATION, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle 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", "--enable-dual-stack", "--enable-propagation", "--
+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 certs-mgmt certificate-authority create-subordinate-ca-managed-internally-issued-by-external-ca --generate-param-json-input subject > subject.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/certs-mgmt/certificate-authority/create-subordinate-ca-managed-internally-issued-by-external-ca.html#cmdoption-compartment-id
+       export issuer_certificate_authority_id=<substitute-value-of-issuer_certificate_authority_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate-authority/create-subordinate-ca-managed-internally-issued-by-external-ca.html#cmdoption-issuer-certificate-authority-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate-authority/create-subordinate-ca-managed-internally-issued-by-external-ca.html#cmdoption-name
+
+       oci certs-mgmt certificate-authority create-subordinate-ca-managed-internally-issued-by-external-ca --compartment-id $compartment_id --issuer-certificate-authority-id $issuer_certificate_authority_id --name $name --subject file://subject.json

oci_cli/help_text_producer/data_files/text/cmdref/certs-mgmt/certificate-authority/list.txt

@@ -79,7 +79,7 @@ state. The state value is case-insensitive.
 
 Accepted values are:
 
-   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
+   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_ACTIVATION, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
 
 --limit [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/certs-mgmt/certificate-authority/update-root-ca-by-generating-config-details.txt

@@ -80,7 +80,13 @@ via the file:// syntax.
 
 --description [text]
 
-A brief description of the CA.
+A brief description of the CA. Avoid entering confidential
+information.
+
+--external-key-description [text]
+
+For externally managed CAs, a description of the externally managed
+key. Avoid entering confidential information.
 
 --force
 
@@ -176,7 +182,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
+   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_ACTIVATION, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
 
 --wait-interval-seconds [integer]
 

oci_cli/help_text_producer/data_files/text/cmdref/certs-mgmt/certificate-authority/update-root-ca-managed-externally.txt

@@ -0,0 +1,222 @@
+"update-root-ca-managed-externally"
+***********************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Updates the properties of the specified certificate authority (CA).
+
+
+Usage
+=====
+
+   oci certs-mgmt certificate-authority update-root-ca-managed-externally [OPTIONS]
+
+
+Required Parameters
+===================
+
+--certificate-authority-id [text]
+
+The OCID of the certificate authority (CA).
+
+--certificate-pem [text]
+
+The externally signed certificate (in PEM format) for the CA.
+
+
+Optional Parameters
+===================
+
+--certificate-authority-rules [complex type]
+
+A list of rules that control how the CA is used and managed.
+
+This option is a JSON list with items of type
+CertificateAuthorityRule.  For documentation on
+CertificateAuthorityRule please see our API reference: https://docs.c
+loud.oracle.com/api/#/en/certificatesmanagement/20210224/datatypes/Ce
+rtificateAuthorityRule. 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.
+
+--certificate-revocation-list-details [complex type]
+
+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.
+
+--current-version-number [integer]
+
+Makes this version the current version. This property can’t be updated
+in combination with any other properties.
+
+--defined-tags [complex type]
+
+Usage of predefined tag keys. These predefined keys are scoped to
+namespaces. Example: *{“foo-namespace”: {“bar-key”: “value”}}* 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]
+
+A brief description of the CA. Avoid entering confidential
+information.
+
+--external-key-description [text]
+
+For externally managed CAs, a description of the externally managed
+key. Avoid entering confidential information.
+
+--force
+
+Perform update without prompting for confirmation.
+
+--freeform-tags [complex type]
+
+Simple key-value pair that is applied without any predefined name,
+type or scope. Exists for cross-compatibility only. Example: *{“bar-
+key”: “value”}* 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 resource to reach the lifecycle state
+defined by "--wait-for-state". Defaults to 1200 seconds.
+
+--stage [text]
+
+The rotation state of the CA. The default is *PENDING*, meaning that
+the CA is staged and available for use. A CA version that you mark as
+*CURRENT* is currently in use, but you don’t yet want to rotate it
+into current, active use. For example, you might create or update a CA
+and mark its rotation state as *PENDING* if you haven’t yet updated
+the certificate on the target system.
+
+Accepted values are:
+
+   CURRENT, PENDING
+
+--version-name [text]
+
+The name of the CA version. When the value is not null, a name is
+unique across versions of a given CA.
+
+--wait-for-state [text]
+
+This operation creates, modifies or deletes a resource that has a
+defined lifecycle state. Specify this option to perform the action and
+then wait until the resource reaches a given lifecycle 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:
+
+   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_ACTIVATION, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
+
+--wait-interval-seconds [integer]
+
+Check every "--wait-interval-seconds" to see whether the resource has
+reached the lifecycle 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", "--enable-dual-stack", "--enable-propagation", "--
+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 certificate_authority_id=<substitute-value-of-certificate_authority_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate-authority/update-root-ca-managed-externally.html#cmdoption-certificate-authority-id
+       export certificate_pem=<substitute-value-of-certificate_pem> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/certs-mgmt/certificate-authority/update-root-ca-managed-externally.html#cmdoption-certificate-pem
+
+       oci certs-mgmt certificate-authority update-root-ca-managed-externally --certificate-authority-id $certificate_authority_id --certificate-pem $certificate_pem

oci_cli/help_text_producer/data_files/text/cmdref/certs-mgmt/certificate-authority/update-subordinate-ca-issued-by-internal-ca.txt

@@ -80,7 +80,13 @@ via the file:// syntax.
 
 --description [text]
 
-A brief description of the CA.
+A brief description of the CA. Avoid entering confidential
+information.
+
+--external-key-description [text]
+
+For externally managed CAs, a description of the externally managed
+key. Avoid entering confidential information.
 
 --force
 
@@ -176,7 +182,7 @@ is returned.
 
 Accepted values are:
 
-   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
+   ACTIVE, CANCELLING_DELETION, CREATING, DELETED, DELETING, FAILED, PENDING_ACTIVATION, PENDING_DELETION, SCHEDULING_DELETION, UPDATING
 
 --wait-interval-seconds [integer]