oracle.oci.oci_os_management_hub_profile – Manage a Profile resource in Oracle Cloud Infrastructure¶

Note

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

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a Profile resource in Oracle Cloud Infrastructure
For state=present, creates a registration profile. A profile defines the content applied to the instance when registering it with the service.
This resource has the following action operations in the oracle.oci.oci_os_management_hub_profile_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
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: X86_64 AARCH64 I686 NOARCH SRC	The architecture type. Applicable when profile_type is 'STATION' Required when profile_type is 'SOFTWARESOURCE'
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.
compartment_id string		The OCID of the compartment that contains the registration profile. Required for create using state=present.
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. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` This parameter is updatable.
description string		User-specified description of the registration profile. This parameter is updatable.
display_name string		A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. 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		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"}` This parameter is updatable.
is_default_profile boolean	Choices: no yes	Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. 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.
lifecycle_stage_id string		The OCID of the lifecycle stage that the instance will be associated with. Required when profile_type is 'LIFECYCLE'
managed_instance_group_id string		The OCID of the managed instance group that the instance will join after registration. Required when profile_type is 'GROUP'
management_station_id string		The OCID of the management station to associate with an instance once registered. Associating with a management station applies only to non-OCI instances.
os_family string	Choices: ORACLE_LINUX_9 ORACLE_LINUX_8 ORACLE_LINUX_7 ORACLE_LINUX_6 WINDOWS_SERVER_2016 WINDOWS_SERVER_2019 WINDOWS_SERVER_2022 ALL	The operating system family. Applicable when profile_type is 'STATION' Required when profile_type is 'SOFTWARESOURCE'
profile_id string		The OCID of the registration profile. 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
profile_type string	Choices: GROUP STATION SOFTWARESOURCE LIFECYCLE	The type of profile. Required for create using state=present.
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.
registration_type string		The type of instance to register.
software_source_ids list / elements=string		The list of software source OCIDs that the registration profile will use. Applicable when profile_type is 'SOFTWARESOURCE'
state string	Choices: present ← absent	The state of the Profile. Use state=present to create or update a Profile. Use state=absent to delete a Profile.
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
vendor_name string	Choices: ORACLE MICROSOFT	The vendor of the operating system for the instance. Applicable when profile_type is 'STATION' Required when profile_type is 'SOFTWARESOURCE'
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.

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 profile with profile_type = GROUP
  oci_os_management_hub_profile:
    # required
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    profile_type: GROUP
    display_name: display_name_example

    # optional
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"
    registration_type: registration_type_example
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create profile with profile_type = STATION
  oci_os_management_hub_profile:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    profile_type: STATION
    display_name: display_name_example

    # optional
    vendor_name: ORACLE
    os_family: ORACLE_LINUX_9
    arch_type: X86_64
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"
    registration_type: registration_type_example
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create profile with profile_type = SOFTWARESOURCE
  oci_os_management_hub_profile:
    # required
    vendor_name: ORACLE
    os_family: ORACLE_LINUX_9
    arch_type: X86_64
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    profile_type: SOFTWARESOURCE
    display_name: display_name_example

    # optional
    software_source_ids: [ "software_source_ids_example" ]
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"
    registration_type: registration_type_example
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create profile with profile_type = LIFECYCLE
  oci_os_management_hub_profile:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    profile_type: LIFECYCLE
    lifecycle_stage_id: "ocid1.lifecyclestage.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    management_station_id: "ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx"
    registration_type: registration_type_example
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update profile
  oci_os_management_hub_profile:
    # required
    profile_id: "ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update profile using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_hub_profile:
    # required
    display_name: display_name_example

    # optional
    description: description_example
    is_default_profile: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete profile
  oci_os_management_hub_profile:
    # required
    profile_id: "ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete profile using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_os_management_hub_profile:
    # 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
profile complex			on success	Details of the Profile resource acted upon by the current operation Sample: {'arch_type': 'X86_64', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_default_profile': True, 'is_service_provided_profile': True, 'lifecycle_environment': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_stage': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_state': 'CREATING', 'managed_instance_group': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'management_station_id': 'ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx', 'os_family': 'ORACLE_LINUX_9', 'profile_type': 'SOFTWARESOURCE', 'registration_type': 'OCI_LINUX', 'software_sources': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'vendor_name': 'ORACLE'}
	arch_type string		on success	The architecture type. Sample: X86_64
	compartment_id string		on success	The OCID of the compartment that contains the registration profile. 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'}}
	description string		on success	The description of the registration profile. Sample: description_example
	display_name string		on success	A user-friendly name for the profile. 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 registration profile. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	is_default_profile boolean		on success	Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified. Sample: True
	is_service_provided_profile boolean		on success	Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances. Sample: True
	lifecycle_environment complex		on success
		display_name string	on success	Lifecycle environment name. Sample: display_name_example
		id string	on success	The OCID of the lifecycle environment. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_stage complex		on success
		display_name string	on success	Lifecycle stage name. Sample: display_name_example
		id string	on success	The OCID of the lifecycle stage. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_state string		on success	The current state of the registration profile. Sample: CREATING
	managed_instance_group complex		on success
		display_name string	on success	Managed instance group name. Sample: display_name_example
		id string	on success	The OCID of the managed instance group. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	management_station_id string		on success	The OCID of the management station to associate with an instance once registered. Associating with a management station applies only to non-OCI instances. Sample: ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx
	os_family string		on success	The operating system family. Sample: ORACLE_LINUX_9
	profile_type string		on success	The type of profile. Sample: SOFTWARESOURCE
	registration_type string		on success	The type of instance to register. Sample: OCI_LINUX
	software_sources complex		on success	The list of software sources that the registration profile will use.
		description string	on success	Software source description. Sample: description_example
		display_name string	on success	Software source name. Sample: display_name_example
		id string	on success	The OCID of the software source. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
		is_mandatory_for_autonomous_linux boolean	on success	Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. Sample: True
		software_source_type string	on success	Type of the software source. Sample: VENDOR
	system_tags dictionary		on success	System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	time_created string		on success	The time the registration profile was created (in RFC 3339 format). Sample: 2013-10-20T19:20:30+01:00
	vendor_name string		on success	The vendor of the operating system for the instance. Sample: ORACLE

Authors¶

Oracle (@oracle)

oracle.oci.oci_os_management_hub_profile – Manage a Profile resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶