oci-cli 3.64.0__py3-none-any.whl → 3.65.0__py3-none-any.whl

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/ingress-gateway-route-table/update.txt

@@ -1,203 +0,0 @@
-"update"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Updates the IngressGatewayRouteTable.
-
-
-Usage
-=====
-
-   oci service-mesh ingress-gateway-route-table update [OPTIONS]
-
-
-Required Parameters
-===================
-
---ingress-gateway-route-table-id [text]
-
-Unique IngressGatewayRouteTable identifier.
-
-
-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 resource. It can be changed after creation. Avoid
-entering confidential information.
-
-Example:
-
-   This is my new resource
-
---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.
-
---priority [integer]
-
-The priority of the route table. Lower value means higher priority.
-The routes are declared based on the priority.
-
---route-rules [complex type]
-
-The route rules for the ingress gateway.
-
-This option is a JSON list with items of type
-IngressGatewayTrafficRouteRuleDetails.  For documentation on
-IngressGatewayTrafficRouteRuleDetails please see our API reference: h
-ttps://docs.cloud.oracle.com/api/#/en/servicemesh/20220615/datatypes/
-IngressGatewayTrafficRouteRuleDetails. 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.
-
---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
-=================
-
-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 service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.json
-
-       oci service-mesh ingress-gateway create --generate-param-json-input hosts > hosts.json
-
-       oci service-mesh ingress-gateway-route-table create --generate-param-json-input route-rules > route-rules.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/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       ingress_gateway_id=$(oci service-mesh ingress-gateway create --compartment-id $compartment_id --hosts file://hosts.json --mesh-id $mesh_id --name $name --query data.id --raw-output)
-
-       ingress_gateway_route_table_id=$(oci service-mesh ingress-gateway-route-table create --compartment-id $compartment_id --ingress-gateway-id $ingress_gateway_id --name $name --route-rules file://route-rules.json --query data.id --raw-output)
-
-       oci service-mesh ingress-gateway-route-table update --ingress-gateway-route-table-id $ingress_gateway_route_table_id

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/ingress-gateway-route-table.txt

@@ -1,25 +0,0 @@
-ingress-gateway-route-table
-***************************
-
-
-Description
-===========
-
-This resource represents a customer-managed ingress gateway route
-table in the Service Mesh.
-
-
-Available Commands
-==================
-
-* change-compartment
-
-* create
-
-* delete
-
-* get
-
-* list
-
-* update

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/ingress-gateway.txt

@@ -1,26 +0,0 @@
-ingress-gateway
-***************
-
-
-Description
-===========
-
-An ingress gateway allows resources that are outside of a mesh to
-communicate to resources that are inside the mesh. It sits on the edge
-of a service mesh receiving incoming HTTP/TCP connections to the mesh.
-
-
-Available Commands
-==================
-
-* change-compartment
-
-* create
-
-* delete
-
-* get
-
-* list
-
-* update

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/mesh/create.txt

@@ -1,190 +0,0 @@
-"create"
-********
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Creates a new Mesh.
-
-
-Usage
-=====
-
-   oci service-mesh mesh create [OPTIONS]
-
-
-Required Parameters
-===================
-
---certificate-authorities [complex type]
-
-The OCID of the certificate authority resource OCID to use for
-creating leaf certificates. 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.
-
---compartment-id, -c [text]
-
-The OCID of the compartment.
-
---display-name [text]
-
-A user-friendly name. The name does not have to be unique and can be
-changed after creation. Avoid entering confidential information.
-
-Example:
-
-   My new resource
-
-
-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 resource. It can be changed after creation. Avoid
-entering confidential information.
-
-Example:
-
-   This is my new resource
-
---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
-
---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.
-
---mtls [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.
-
---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
-=================
-
-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 service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.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/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/mesh/get.txt

@@ -1,99 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Required Parameters
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Gets a Mesh by identifier.
-
-
-Usage
-=====
-
-   oci service-mesh mesh get [OPTIONS]
-
-
-Required Parameters
-===================
-
---mesh-id [text]
-
-Unique Mesh identifier.
-
-
-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 service-mesh mesh create --generate-param-json-input certificate-authorities > certificate-authorities.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/service-mesh/mesh/create.html#cmdoption-compartment-id
-       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/service-mesh/mesh/create.html#cmdoption-display-name
-
-       mesh_id=$(oci service-mesh mesh create --certificate-authorities file://certificate-authorities.json --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
-
-       oci service-mesh mesh get --mesh-id $mesh_id

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/mesh.txt

@@ -1,27 +0,0 @@
-mesh
-****
-
-
-Description
-===========
-
-The mesh resource is the top-level container that represents the
-logical boundary of application traffic between the services and
-deployments that reside within it. A mesh also provides a unit of
-access control.
-
-
-Available Commands
-==================
-
-* change-compartment
-
-* create
-
-* delete
-
-* get
-
-* list
-
-* update

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/proxy-details/get.txt

@@ -1,79 +0,0 @@
-"get"
-*****
-
-* Description
-
-* Usage
-
-* Optional Parameters
-
-* Global Parameters
-
-* Example using required parameter
-
-
-Description
-===========
-
-Returns the attributes of the Proxy such as proxy image version.
-
-
-Usage
-=====
-
-   oci service-mesh proxy-details get [OPTIONS]
-
-
-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 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.
-
-       oci service-mesh proxy-details get

oci_cli/help_text_producer/data_files/text/cmdref/service-mesh/proxy-details.txt

@@ -1,14 +0,0 @@
-proxy-details
-*************
-
-
-Description
-===========
-
-Details of the proxy such as version of the proxy image.
-
-
-Available Commands
-==================
-
-* get