oracle / oracle.oci / 4.32.0 / module / oci_compute_image_capability_schema_facts Fetches details about one or multiple ComputeImageCapabilitySchema resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_image_capability_schema_facts (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
Fetches details about one or multiple ComputeImageCapabilitySchema resources in Oracle Cloud Infrastructure
Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
If I(compute_image_capability_schema_id) is specified, the details of a single ComputeImageCapabilitySchema will be returned.
- name: Get a specific compute_image_capability_schema oci_compute_image_capability_schema_facts: # required compute_image_capability_schema_id: "ocid1.computeimagecapabilityschema.oc1..xxxxxxEXAMPLExxxxxx" # optional is_merge_enabled: true
- name: List compute_image_capability_schemas oci_compute_image_capability_schema_facts: # optional compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx" display_name: display_name_example sort_by: TIMECREATED sort_order: ASC
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 sort_by: choices: - TIMECREATED - DISPLAYNAME description: - The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. - '**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.' 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 image_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an image. type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token 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 sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. 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 display_name: aliases: - name description: - A filter to return only resources that match the given display name exactly. type: str compartment_id: description: - A filter to return only resources that match the given compartment OCID exactly. type: str is_merge_enabled: description: - Merge the image capability schema with the global image capability schema type: bool 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 compute_image_capability_schema_id: aliases: - id description: - The id of the compute image capability schema or the image ocid - Required to get a specific compute_image_capability_schema. 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
compute_image_capability_schemas: contains: compartment_id: description: - The OCID of the compartment that contains the resource. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str compute_global_image_capability_schema_id: description: - The ocid of the compute global image capability schema - Returned for get operation returned: on success sample: ocid1.computeglobalimagecapabilityschema.oc1..xxxxxxEXAMPLExxxxxx type: str compute_global_image_capability_schema_version_name: description: - The name of the compute global image capability schema version returned: on success sample: compute_global_image_capability_schema_version_name_example type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str freeform_tags: description: - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The id of the compute global image capability schema version returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str image_id: description: - The OCID of the image associated with this compute image capability schema returned: on success sample: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx type: str schema_data: contains: boolean_default_value: description: - the default value returned: on success sample: true type: bool descriptor_type: description: - The image capability schema descriptor type for the capability returned: on success sample: boolean type: str enum_integer_default_value: description: - the default value returned: on success sample: 56 type: int enum_integer_values: description: - the list of values for the enum returned: on success sample: [] type: list enum_string_default_value: description: - the default value returned: on success sample: default_value_example type: str enum_string_values: description: - the list of values for the enum returned: on success sample: [] type: list source: description: - '' returned: on success sample: GLOBAL type: str description: - The map of each capability name to its ImageCapabilityDescriptor. returned: on success type: complex time_created: description: - The date and time the compute image capability schema was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - List of ComputeImageCapabilitySchema resources returned: on success sample: - compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx compute_global_image_capability_schema_id: ocid1.computeglobalimagecapabilityschema.oc1..xxxxxxEXAMPLExxxxxx compute_global_image_capability_schema_version_name: compute_global_image_capability_schema_version_name_example defined_tags: Operations: CostCenter: US display_name: display_name_example freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx image_id: ocid1.image.oc1..xxxxxxEXAMPLExxxxxx schema_data: boolean_default_value: true descriptor_type: boolean enum_integer_default_value: 56 enum_integer_values: [] enum_string_default_value: default_value_example enum_string_values: [] source: GLOBAL time_created: '2013-10-20T19:20:30+01:00' type: complex