oracle.oci.oci_os_management_software_source – Manage a SoftwareSource resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_os_management_software_source.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a SoftwareSource resource in Oracle Cloud Infrastructure

  • For state=present, creates a new custom Software Source on the management system. This will not contain any packages after it is first created, and they must be added later.

  • This resource has the following action operations in the oracle.oci.oci_os_management_software_source_actions module: add_packages, change_compartment, remove_packages.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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).
arch_type
string
    Choices:
  • IA_32
  • X86_64
  • AARCH64
  • SPARC
  • AMD64_DEBIAN
The architecture type supported by the Software Source
Required for create using state=present.
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
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.
checksum_type
string
    Choices:
  • SHA1
  • SHA256
  • SHA384
  • SHA512
The yum repository checksum type used by this software source
This parameter is updatable.
compartment_id
string
OCID for the Compartment
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
description
string
Information specified by the user about the software source
This parameter is updatable.
display_name
string
User friendly name for the software source
Required for create using state=present.
Required for 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
    Choices:
  • no ←
  • yes
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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
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.
maintainer_email
string
Email address of the person maintaining this software source
This parameter is updatable.
maintainer_name
string
Name of the person maintaining this software source
This parameter is updatable.
maintainer_phone
string
Phone number of the person maintaining this software source
This parameter is updatable.
parent_id
string
OCID for the parent software source, if there is one
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.
software_source_id
string
The OCID of the software source.
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
state
string
    Choices:
  • present ←
  • absent
The state of the SoftwareSource.
Use state=present to create or update a SoftwareSource.
Use state=absent to delete a SoftwareSource.
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
    Choices:
  • no
  • yes ←
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.

Examples

- name: Create software_source
  oci_os_management_software_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    arch_type: IA_32
    display_name: display_name_example

    # optional
    parent_id: "ocid1.parent.oc1..xxxxxxEXAMPLExxxxxx"
    description: description_example
    maintainer_name: maintainer_name_example
    maintainer_email: maintainer_email_example
    maintainer_phone: maintainer_phone_example
    checksum_type: SHA1
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update software_source
  oci_os_management_software_source:
    # required
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    maintainer_name: maintainer_name_example
    maintainer_email: maintainer_email_example
    maintainer_phone: maintainer_phone_example
    checksum_type: SHA1
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update software_source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_software_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    maintainer_name: maintainer_name_example
    maintainer_email: maintainer_email_example
    maintainer_phone: maintainer_phone_example
    checksum_type: SHA1
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete software_source
  oci_os_management_software_source:
    # required
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete software_source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_software_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    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
software_source
complex
on success
Details of the SoftwareSource resource acted upon by the current operation

Sample:
{'arch_type': 'IA_32', 'associated_managed_instances': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'checksum_type': 'SHA1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'gpg_key_fingerprint': 'gpg_key_fingerprint_example', 'gpg_key_id': 'ocid1.gpgkey.oc1..xxxxxxEXAMPLExxxxxx', 'gpg_key_url': 'gpg_key_url_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'maintainer_email': 'maintainer_email_example', 'maintainer_name': 'maintainer_name_example', 'maintainer_phone': 'maintainer_phone_example', 'packages': 56, 'parent_id': 'ocid1.parent.oc1..xxxxxxEXAMPLExxxxxx', 'parent_name': 'parent_name_example', 'repo_type': 'repo_type_example', 'status': 'NORMAL', 'url': 'url_example'}
 
arch_type
string
on success
The architecture type supported by the Software Source

Sample:
IA_32
 
associated_managed_instances
complex
on success
list of the Managed Instances associated with this Software Sources

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
checksum_type
string
on success
The yum repository checksum type used by this software source

Sample:
SHA1
 
compartment_id
string
on success
OCID for the Compartment

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Information specified by the user about the software source

Sample:
description_example
 
display_name
string
on success
User friendly name for the software source

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
gpg_key_fingerprint
string
on success
Fingerprint of the GPG key for this software source

Sample:
gpg_key_fingerprint_example
 
gpg_key_id
string
on success
ID of the GPG key for this software source

Sample:
ocid1.gpgkey.oc1..xxxxxxEXAMPLExxxxxx
 
gpg_key_url
string
on success
URL of the GPG key for this software source

Sample:
gpg_key_url_example
 
id
string
on success
OCID for the Software Source

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the Software Source.

Sample:
CREATING
 
maintainer_email
string
on success
Email address of the person maintaining this software source

Sample:
maintainer_email_example
 
maintainer_name
string
on success
Name of the person maintaining this software source

Sample:
maintainer_name_example
 
maintainer_phone
string
on success
Phone number of the person maintaining this software source

Sample:
maintainer_phone_example
 
packages
integer
on success
Number of packages

Sample:
56
 
parent_id
string
on success
OCID for the parent software source, if there is one

Sample:
ocid1.parent.oc1..xxxxxxEXAMPLExxxxxx
 
parent_name
string
on success
Display name the parent software source, if there is one

Sample:
parent_name_example
 
repo_type
string
on success
Type of the Software Source

Sample:
repo_type_example
 
status
string
on success
status of the software source.

Sample:
NORMAL
 
url
string
on success
URL for the repostiory

Sample:
url_example


Authors

  • Oracle (@oracle)