oracle.oci.oci_apigateway_sdk_facts – Fetches details about one or multiple Sdk resources in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_apigateway_sdk_facts.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Fetches details about one or multiple Sdk resources in Oracle Cloud Infrastructure
Returns list of generated SDKs.
If sdk_id is specified, the details of a single Sdk will be returned.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_id string		The ocid of the API.
api_user string		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 `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		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 `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		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 `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `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 `config_file_location`).
auth_purpose string	Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string	Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see 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 `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle string		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.
config_file_location string		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.
config_profile_name string		The profile to load from the config file referenced by `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 `config_file_location`.
display_name string		A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource` aliases: name
lifecycle_state string	Choices: CREATING ACTIVE FAILED DELETING DELETED	A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` or `DELETED`
realm_specific_endpoint_template_enabled boolean	Choices: no yes	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.
region string		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 `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sdk_id string		The ocid of the SDK. Required to get a specific sdk. aliases: id
sort_by string	Choices: timeCreated displayName	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.
sort_order string	Choices: ASC DESC	The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
tenancy string		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 `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get a specific sdk
  oci_apigateway_sdk_facts:
    # required
    sdk_id: "ocid1.sdk.oc1..xxxxxxEXAMPLExxxxxx"

- name: List sdks
  oci_apigateway_sdk_facts:

    # optional
    sdk_id: "ocid1.sdk.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated
    api_id: "ocid1.api.oc1..xxxxxxEXAMPLExxxxxx"

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
sdks complex		on success	List of Sdk resources Sample: [{'api_id': 'ocid1.api.oc1..xxxxxxEXAMPLExxxxxx', 'artifact_url': 'artifact_url_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'parameters': {}, 'target_language': 'target_language_example', 'time_artifact_url_expires_at': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
	api_id string	on success	The OCID of API resource Returned for get operation Sample: ocid1.api.oc1..xxxxxxEXAMPLExxxxxx
	artifact_url string	on success	File location for generated SDK. Returned for get operation Sample: artifact_url_example
	compartment_id string	on success	The OCID of the compartment in which the resource is created. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	defined_tags dictionary	on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	display_name string	on success	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` Sample: display_name_example
	freeform_tags dictionary	on success	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 Resource Tags. Example: `{"Department": "Finance"}` Sample: {'Department': 'Finance'}
	id string	on success	The OCID of the resource. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_details string	on success	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state. Returned for get operation Sample: lifecycle_details_example
	lifecycle_state string	on success	The current state of the SDK. - The SDK will be in CREATING state if the SDK creation is in progress. - The SDK will be in ACTIVE state if create is successful. - The SDK will be in FAILED state if the create, or delete fails. - The SDK will be in DELETING state if the deletion in in progress. - The SDK will be in DELETED state if the delete is successful. Sample: CREATING
	parameters dictionary	on success	Additional optional configurations passed. The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called. Example: `{"configName": "configValue"}` Returned for get operation
	target_language string	on success	The string representing the target programming language for generating the SDK. Sample: target_language_example
	time_artifact_url_expires_at string	on success	Expiry of artifact url. Returned for get operation Sample: 2013-10-20T19:20:30+01:00
	time_created string	on success	The time this resource was created. An RFC3339 formatted datetime string. Sample: 2013-10-20T19:20:30+01:00
	time_updated string	on success	The time this resource was last updated. An RFC3339 formatted datetime string. Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_apigateway_sdk_facts – Fetches details about one or multiple Sdk resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶