oci-cli 3.62.2__py3-none-any.whl → 3.63.1__py3-none-any.whl

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

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

@@ -0,0 +1,150 @@
+"list"
+******
+
+* Description
+
+* Usage
+
+* Required Parameters
+
+* Optional Parameters
+
+* Global Parameters
+
+* Example using required parameter
+
+
+Description
+===========
+
+A list of Management Agent Data Sources for the given Management Agent
+Id.
+
+
+Usage
+=====
+
+   oci management-agent named-credential list [OPTIONS]
+
+
+Required Parameters
+===================
+
+--management-agent-id [text]
+
+The ManagementAgentID of the agent from which the named credentials
+are associated.
+
+
+Optional Parameters
+===================
+
+--all
+
+Fetches all pages of results. If you provide this option, then you
+cannot provide the "--limit" option.
+
+--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
+
+--id [text]
+
+Filter list for these Named credentials identifiers (ocid) values.
+
+--lifecycle-state [text]
+
+Filter to return only Management Agents in the particular lifecycle
+state.
+
+Accepted values are:
+
+   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING
+
+--limit [integer]
+
+The maximum number of items to return.
+
+--name [text]
+
+Filter list for these name items.
+
+--page [text]
+
+The page token representing the page at which to start retrieving
+results. This is usually retrieved from a previous list call.
+
+--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. Only one sort order may be provided. If no value
+is specified timeCreated is default.
+
+Accepted values are:
+
+   lifecycleState, name, timeCreated, type
+
+--sort-order [text]
+
+The sort order to use, either ‘asc’ or ‘desc’.
+
+Accepted values are:
+
+   ASC, DESC
+
+--type [text]
+
+Filter list for these type values.
+
+
+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 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/list.html#cmdoption-management-agent-id
+
+       oci management-agent named-credential list --management-agent-id $management_agent_id

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

@@ -0,0 +1,18 @@
+named-credential
+****************
+
+
+Description
+===========
+
+A representation of a named credential in the Management Agent.
+
+
+Available Commands
+==================
+
+* create
+
+* get-named-cred-metadata
+
+* list

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

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

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

@@ -203,7 +203,7 @@ The OperationType of the workRequest
 
 Accepted values are:
 
-   AGENTIMAGE_UPGRADE, CREATE_DATA_SOURCE, CREATE_UPGRADE_PLUGINS, DELETE_DATA_SOURCE, DEPLOY_PLUGIN, UPDATE_DATA_SOURCE, UPGRADE_PLUGIN
+   AGENTIMAGE_UPGRADE, AGENT_UPGRADE, CREATE_DATA_SOURCE, CREATE_NAMEDCREDENTIALS, CREATE_PLUGIN, CREATE_UPGRADE_PLUGINS, DELETE_DATA_SOURCE, DELETE_NAMEDCREDENTIALS, DEPLOY_PLUGIN, UPDATE_DATA_SOURCE, UPDATE_NAMEDCREDENTIALS, UPGRADE_PLUGIN
 
 
 Global Parameters

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

@@ -21,6 +21,8 @@ Available Commands
 
   * delete-data-source
 
+  * delete-named-credential
+
   * deploy-plugins
 
   * get
@@ -29,6 +31,8 @@ Available Commands
 
   * get-data-source
 
+  * get-named-credential
+
   * list
 
   * list-availability-histories
@@ -43,6 +47,8 @@ Available Commands
 
   * update
 
+  * update-named-credential
+
   * update-prometheus-datasource
 
 * agent-image
@@ -63,6 +69,14 @@ Available Commands
 
   * update
 
+* named-credential
+
+  * create
+
+  * get-named-cred-metadata
+
+  * list
+
 * plugin
 
   * list

oci_cli/help_text_producer/data_files/text/cmdref/management-dashboard/dashboard/get-oob.txt

@@ -17,8 +17,9 @@
 Description
 ===========
 
-Gets an OOB dashboard and its saved searches by ID.  Deleted or
-unauthorized saved searches are marked by tile’s state property.
+Gets an out-of-the-box dashboard and its saved searches by ID.
+Deleted or unauthorized saved searches are marked by tile’s state
+property.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/management-dashboard/dashboard/import.txt

@@ -111,6 +111,30 @@ 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.
 
+--override-dashboard-compartment-ocid [text]
+
+If this attribute is set, the dashboard resources are created or
+updated in the compartment specified by OCID. If this attribute is not
+set, the compartment specified in the JSON metadata is used.
+
+--override-same-name [text]
+
+By default, if a resource with the same OCID exists in the target
+compartment, it is updated during the import process, otherwise, a new
+resource is created. However, if this attribute is set to true, then
+during the import process if a resource with the same displayName
+exists in the compartment, then it is updated even if the OCIDs are
+different. This is useful when importing the same resource multiple
+times. If the compartment and displayName remain the same, the
+resource is only updated and multiple copies of a resource are not
+created.
+
+--override-saved-search-compartment-ocid [text]
+
+If this attribute is set, the saved search resources are created or
+updated in the compartment specified by OCID. If this attribute is not
+set, the compartment specified in the JSON metadata is used.
+
 
 Global Parameters
 =================

oci_cli/help_text_producer/data_files/text/cmdref/management-dashboard/dashboard/list-oob.txt

@@ -17,8 +17,8 @@
 Description
 ===========
 
-Gets the list of OOB dashboards with pagination.  Returned properties
-are the summary.
+Gets the list of out-of-the-box dashboards with pagination. Returned
+properties are the summary.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/management-dashboard/saved-search/get-oob.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Gets a saved search by ID.
+Gets an out-of-the-box saved search by ID.
 
 
 Usage

oci_cli/help_text_producer/data_files/text/cmdref/management-dashboard/saved-search/list-oob.txt

@@ -17,7 +17,7 @@
 Description
 ===========
 
-Gets the list of out-of-box saved searches in a compartment with
+Gets the list of out-of-the-box saved searches in a compartment with
 pagination.  Returned properties are the summary.
 
 

oci_cli/help_text_producer/data_files/text/cmdref/marketplace-publisher/artifact/change-compartment.txt

@@ -72,6 +72,32 @@ 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, NEEDS_ATTENTION, SUCCEEDED, WAITING
+
+--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
 =================