oracle / oracle.oci / 4.21.0 / module / oci_object_storage_namespace_metadata Manage a NamespaceMetadata resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_object_storage_namespace_metadata (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
This module allows the user to update a NamespaceMetadata resource in Oracle Cloud Infrastructure
- name: Update namespace_metadata oci_object_storage_namespace_metadata: # required namespace_name: namespace_name_example # optional default_s3_compartment_id: "ocid1.defaults3compartment.oc1..xxxxxxEXAMPLExxxxxx" default_swift_compartment_id: "ocid1.defaultswiftcompartment.oc1..xxxxxxEXAMPLExxxxxx"
state: choices: - present default: present description: - The state of the NamespaceMetadata. - Use I(state=present) to update an existing a NamespaceMetadata. required: false type: str region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str namespace_name: description: - The Object Storage namespace used for the request. required: true type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str default_s3_compartment_id: description: - The updated compartment id for use by an S3 client, if this field is set. - This parameter is updatable. type: str default_swift_compartment_id: description: - The updated compartment id for use by a Swift client, if this field is set. - This parameter is updatable. type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
namespace_metadata: contains: default_s3_compartment_id: description: - If the field is set, specifies the default compartment assignment for the Amazon S3 Compatibility API. returned: on success sample: ocid1.defaults3compartment.oc1..xxxxxxEXAMPLExxxxxx type: str default_swift_compartment_id: description: - If the field is set, specifies the default compartment assignment for the Swift API. returned: on success sample: ocid1.defaultswiftcompartment.oc1..xxxxxxEXAMPLExxxxxx type: str namespace: description: - The Object Storage namespace to which the metadata belongs. returned: on success sample: namespace_example type: str description: - Details of the NamespaceMetadata resource acted upon by the current operation returned: on success sample: default_s3_compartment_id: ocid1.defaults3compartment.oc1..xxxxxxEXAMPLExxxxxx default_swift_compartment_id: ocid1.defaultswiftcompartment.oc1..xxxxxxEXAMPLExxxxxx namespace: namespace_example type: complex