oracle.oci.oci_resource_manager_configuration_source_provider – Manage a ConfigurationSourceProvider resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_resource_manager_configuration_source_provider
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ConfigurationSourceProvider resource in Oracle Cloud Infrastructure
For state=present, creates a configuration source provider in the specified compartment. For more information, see To create a configuration source provider.
This resource has the following action operations in the oracle.oci.oci_resource_manager_configuration_source_provider_actions module: change_compartment.
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 | |
---|---|---|---|
access_token
string
|
The personal access token to be configured on the GitLab repository. Avoid entering confidential information.
Required for create using state=present.
This parameter is updatable.
Applicable when config_source_provider_type is one of ['GITLAB_ACCESS_TOKEN', 'GITHUB_ACCESS_TOKEN']
|
||
api_endpoint
string
|
The Git service endpoint. Example: `https://gitlab.com`
Required for create using state=present.
This parameter is updatable.
Applicable when config_source_provider_type is one of ['GITLAB_ACCESS_TOKEN', 'GITHUB_ACCESS_TOKEN']
|
||
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
|
|
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
|
|
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.
|
||
compartment_id
string
|
The OCID of the compartment where you want to create the configuration source provider.
|
||
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 . |
||
config_source_provider_type
string
|
|
The type of configuration source provider. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub.
Required for create using state=present, update using state=present with configuration_source_provider_id present.
Applicable when config_source_provider_type is one of ['GITLAB_ACCESS_TOKEN', 'GITHUB_ACCESS_TOKEN']
|
|
configuration_source_provider_id
string
|
The OCID of the configuration source provider.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
||
description
string
|
Description of the configuration source provider. Avoid entering confidential information.
This parameter is updatable.
|
||
display_name
string
|
Human-readable name of the configuration source provider. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
freeform_tags
dictionary
|
Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
private_server_config_details
dictionary
|
This parameter is updatable.
|
||
certificate_id
string
/ required
|
The OCID of a certificate associated with the configuration source provider.
Required when config_source_provider_type is 'GITLAB_ACCESS_TOKEN'
|
||
private_endpoint_id
string
/ required
|
The OCID of a private endpoint associated with the configuration source provider.
Required when config_source_provider_type is 'GITLAB_ACCESS_TOKEN'
|
||
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. |
||
state
string
|
|
The state of the ConfigurationSourceProvider.
Use state=present to create or update a ConfigurationSourceProvider.
Use state=absent to delete a ConfigurationSourceProvider.
|
|
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 |
||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create configuration_source_provider with config_source_provider_type = GITLAB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITLAB_ACCESS_TOKEN
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: Create configuration_source_provider with config_source_provider_type = GITHUB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITHUB_ACCESS_TOKEN
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: Update configuration_source_provider with config_source_provider_type = GITLAB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITLAB_ACCESS_TOKEN
# optional
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: Update configuration_source_provider with config_source_provider_type = GITHUB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITHUB_ACCESS_TOKEN
# optional
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: >
Update configuration_source_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
with config_source_provider_type = GITLAB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITLAB_ACCESS_TOKEN
# optional
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: >
Update configuration_source_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
with config_source_provider_type = GITHUB_ACCESS_TOKEN
oci_resource_manager_configuration_source_provider:
# required
config_source_provider_type: GITHUB_ACCESS_TOKEN
# optional
display_name: display_name_example
description: description_example
private_server_config_details:
# required
private_endpoint_id: "ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx"
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
api_endpoint: api_endpoint_example
access_token: access_token_example
- name: Delete configuration_source_provider
oci_resource_manager_configuration_source_provider:
# required
configuration_source_provider_id: "ocid1.configurationsourceprovider.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete configuration_source_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_resource_manager_configuration_source_provider:
# required
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
configuration_source_provider
complex
|
on success |
Details of the ConfigurationSourceProvider resource acted upon by the current operation
Sample:
{'api_endpoint': 'api_endpoint_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'config_source_provider_type': 'GITLAB_ACCESS_TOKEN', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'private_server_config_details': {'certificate_id': 'ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx', 'private_endpoint_id': 'ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '2013-10-20T19:20:30+01:00'}
|
||
api_endpoint
string
|
on success |
The GitHub service endpoint. Example: `https://github.com/`
Sample:
api_endpoint_example
|
||
compartment_id
string
|
on success |
The OCID of the compartment where the configuration source provider is located.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
config_source_provider_type
string
|
on success |
The type of configuration source provider. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub.
Sample:
GITLAB_ACCESS_TOKEN
|
||
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'}}
|
||
description
string
|
on success |
Description of the configuration source provider.
Sample:
description_example
|
||
display_name
string
|
on success |
Human-readable display name for the configuration source provider.
Sample:
display_name_example
|
||
freeform_tags
dictionary
|
on success |
Free-form tags associated with this resource. Each tag is a 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 configuration source provider.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The current lifecycle state of the configuration source provider. For more information about configuration source provider lifecycle states in Resource Manager, see Key Concepts.
Sample:
ACTIVE
|
||
private_server_config_details
complex
|
on success |
|
||
certificate_id
string
|
on success |
The OCID of a certificate associated with the configuration source provider.
Sample:
ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx
|
||
private_endpoint_id
string
|
on success |
The OCID of a private endpoint associated with the configuration source provider.
Sample:
ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
The date and time when the configuration source provider was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)