oci-cli 3.62.1__py3-none-any.whl → 3.63.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/{marketplace-publisher/attachment/attachment/delete.txt → management-agent/agent/delete-named-credential.txt}

@@ -1,5 +1,5 @@
-"delete"
-********
+"delete-named-credential"
+*************************
 
 * Description
 
@@ -17,25 +17,22 @@
 Description
 ===========
 
-Deletes a Attachment resource by identifier
+Named credential delete request to sent to associated Management
+Agent.
 
 
 Usage
 =====
 
-   oci marketplace-publisher attachment attachment delete [OPTIONS]
+   oci management-agent agent delete-named-credential [OPTIONS]
 
 
 Required Parameters
 ===================
 
---attachment-id [text]
+--named-credential-id [text]
 
-unique Offer identifier
-
---offer-id [text]
-
-unique Offer identifier
+Named credential ID
 
 
 Optional Parameters
@@ -93,7 +90,7 @@ of 2 is returned. For any other error, a return code of 1 is returned.
 
 Accepted values are:
 
-   ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
+   ACCEPTED, CANCELED, CANCELING, CREATED, FAILED, IN_PROGRESS, SUCCEEDED
 
 --wait-interval-seconds [integer]
 
@@ -120,6 +117,11 @@ 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 management-agent named-credential create --generate-param-json-input properties > properties.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.
@@ -128,13 +130,10 @@ 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 display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-display-name
-       export seller_compartment_id=<substitute-value-of-seller_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/offer/offer/create.html#cmdoption-seller-compartment-id
-       export file_base64_encoded=<substitute-value-of-file_base64_encoded> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/attachment/attachment/create.html#cmdoption-file-base64-encoded
-       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/marketplace-publisher/attachment/attachment/create.html#cmdoption-type
-
-       offer_id=$(oci marketplace-publisher offer offer create --display-name $display_name --seller-compartment-id $seller_compartment_id --query data.id --raw-output)
+       export management_agent_id=<substitute-value-of-management_agent_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-management-agent-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-name
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-type
 
-       attachment_id=$(oci marketplace-publisher attachment attachment create --display-name $display_name --file-base64-encoded $file_base64_encoded --offer-id $offer_id --type $type --query data.id --raw-output)
+       named_credential_id=$(oci management-agent named-credential create --management-agent-id $management_agent_id --name $name --properties file://properties.json --type $type --query data.id --raw-output)
 
-       oci marketplace-publisher attachment attachment delete --attachment-id $attachment_id --offer-id $offer_id
+       oci management-agent agent delete-named-credential --named-credential-id $named_credential_id

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/agent/get-named-credential.txt

@@ -0,0 +1,100 @@
+"get-named-credential"
+**********************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Get Named credential details for given Id and given Management Agent.
+
+
+Usage
+=====
+
+   oci management-agent agent get-named-credential [OPTIONS]
+
+
+Required Parameters
+===================
+
+--named-credential-id [text]
+
+Named credential ID
+
+
+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
+
+
+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 management-agent named-credential create --generate-param-json-input properties > properties.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 management_agent_id=<substitute-value-of-management_agent_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-management-agent-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-name
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-type
+
+       named_credential_id=$(oci management-agent named-credential create --management-agent-id $management_agent_id --name $name --properties file://properties.json --type $type --query data.id --raw-output)
+
+       oci management-agent agent get-named-credential --named-credential-id $named_credential_id

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/agent/list.txt

@@ -159,7 +159,7 @@ Filter to return only results having the particular platform type.
 
 Accepted values are:
 
-   LINUX, MACOSX, SOLARIS, WINDOWS
+   AIX, LINUX, MACOSX, SOLARIS, WINDOWS
 
 --plugin-name [text]
 

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/agent/update-named-credential.txt

@@ -0,0 +1,182 @@
+"update-named-credential"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Named credential update request to given Management Agent.
+
+
+Usage
+=====
+
+   oci management-agent agent update-named-credential [OPTIONS]
+
+
+Required Parameters
+===================
+
+--named-credential-id [text]
+
+Named credential ID
+
+--properties [complex type]
+
+Properties for the named credential 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
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. 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]
+
+Description of the Named Credential.
+
+--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 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, CREATED, FAILED, IN_PROGRESS, SUCCEEDED
+
+--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 management-agent named-credential create --generate-param-json-input properties > properties.json
+
+       oci management-agent agent update-named-credential --generate-param-json-input properties > properties.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 management_agent_id=<substitute-value-of-management_agent_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-management-agent-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-name
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-type
+
+       named_credential_id=$(oci management-agent named-credential create --management-agent-id $management_agent_id --name $name --properties file://properties.json --type $type --query data.id --raw-output)
+
+       oci management-agent agent update-named-credential --named-credential-id $named_credential_id --properties file://properties.json

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/agent.txt

@@ -18,6 +18,8 @@ Available Commands
 
 * delete-data-source
 
+* delete-named-credential
+
 * deploy-plugins
 
 * get
@@ -26,6 +28,8 @@ Available Commands
 
 * get-data-source
 
+* get-named-credential
+
 * list
 
 * list-availability-histories
@@ -40,4 +44,6 @@ Available Commands
 
 * update
 
+* update-named-credential
+
 * update-prometheus-datasource

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/named-credential/create.txt

@@ -0,0 +1,184 @@
+"create"
+********
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Named credential creation request to given Management Agent.
+
+
+Usage
+=====
+
+   oci management-agent named-credential create [OPTIONS]
+
+
+Required Parameters
+===================
+
+--management-agent-id [text]
+
+The Management Agent parent resource to associate this named
+credential with.  This is the ManagementAgent resource OCID.
+
+--name [text]
+
+Identifier for Named Credential. This is unique for the Management
+Agent.
+
+--properties [complex type]
+
+Properties for the named credential 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.
+
+--type [text]
+
+The type of the Named Credential.
+
+
+Optional Parameters
+===================
+
+--defined-tags [complex type]
+
+Defined tags for this resource. Each key is predefined and scoped to a
+namespace. 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]
+
+Description of the Named Credential.
+
+--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 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, CREATED, FAILED, IN_PROGRESS, SUCCEEDED
+
+--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 management-agent named-credential create --generate-param-json-input properties > properties.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 management_agent_id=<substitute-value-of-management_agent_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-management-agent-id
+       export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-name
+       export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/management-agent/named-credential/create.html#cmdoption-type
+
+       oci management-agent named-credential create --management-agent-id $management_agent_id --name $name --properties file://properties.json --type $type

oci_cli/help_text_producer/data_files/text/cmdref/management-agent/named-credential/get-named-cred-metadata.txt

@@ -0,0 +1,97 @@
+"get-named-cred-metadata"
+*************************
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+Return the Metadata definition for Named Credentials supported by
+Management Agent.
+
+
+Usage
+=====
+
+   oci management-agent named-credential get-named-cred-metadata [OPTIONS]
+
+
+Required Parameters
+===================
+
+--compartment-id, -c [text]
+
+The OCID of the compartment to which a request will be scoped.
+
+
+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
+
+--management-agent-id [text]
+
+Filter the named credential metadata which is compatible with the
+given Management Agent identifier.
+
+
+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/management-agent/named-credential/get-named-cred-metadata.html#cmdoption-compartment-id
+
+       oci management-agent named-credential get-named-cred-metadata --compartment-id $compartment_id